\documentclass[a4paper]{report}
\usepackage{noweb}
%\usepackage{pretzel-noweb}
\pagestyle{noweb}
\noweboptions{externalindex}
\usepackage[OT1,T1]{fontenc}
\usepackage[latin1]{inputenc}
\usepackage{epsfig}
\nonstopmode  
\def\todo#1{\marginpar{\epsfig{file=Work.ps} #1}}
\def\Info{\marginpar{\epsfig{file=Info.ps}}}
\begin{document}
\parindent0mm
\parskip 0.5ex

\def\IFmapper{\emph{IFmapper}}

\parindent0mm
\nonstopmode
\begin{titlepage}
  \vspace{2cm}
  \vfill
  \begin{center}
    \Huge\bf IFmapper 0.8.5\\A mapping tool for Interactive Fiction\\
    \vspace{1cm}

    \Large\bf \copyright 1999/2000 Ingo Kessinger\\
    \vfill
    \vspace{3cm}
  \end{center}
\end{titlepage}

\cleardoublepage

\tableofcontents
\clearpage

\chapter{Preamble}

\section{Motivation}

The palm is a nearly ideal platform for IF. It is small, light weight,
has more than enough memory for the interpreter and a couple of games
and lasts 10h+ on a pair of AAA rechargables.

The only problem is, that I keep loosing my way without a map and
juggling a notebook and the palm while waiting in line is hardly
convenient. So some sort of mapping program was needed and the idea
for \IFmapper was born.

\IFmapper isn´t designed to be a tool with a lot of bells and
whistles, the main advantage of palm program is a small memory
footprint and efficiency. With 40k the former is certainly achieved,
while still getting the job done. The interface is reasonably simple
and within the bounds of the Palm´s limited display capacity allows
you to draw and rearrange all items comfortably. Unfortunately map
loading time is a little long on larger maps, so the flow of the game
is somewhat lost while switching between game interpreter and
\IFmapper.

\section{Description}

A map is organized in sections and consists of \emph{locations},
connections and text. With IFmapper you can create and manipulate
these elements in an object oriented fashion. Figure \ref{fig:edzork1}
shows a sample from the map of \emph{Zork I}.

\begin{figure}[ht]
  \begin{center}
    \epsfig{file=mapper1.ps}
    \caption{Screenshot of an editing session of \emph{Zork I}}
    \label{fig:edzork1}
  \end{center}
\end{figure}

The connections are in no way associated with the points of the
compass -- it will be convenient to treat them this way most of the
time, but from the POV of \IFmapper they are just lines with no
particular meaning. One way connections are displayed as arrows and a
number of line styles can be used for passages, that need problem
solving, but again this isn´t enforced in any way.

Locations have a name, that is displayed on the map screen and a
description, that can be used for items found or notes.  The shape of
the locations is restricted to rectangular and circular, I thought
about implementing arbitrarily shaped polygons, but this could
probably only be used in a few instances\footnote{e.g. the
  \emph{Pentagram Room} in \emph{Zork II}} and so I decided against
it.

Text is probably the most problematic item in the small store, because
unlike the other two, it can´t be scaled and gets in the way if you
zoom in and out. To alleviate the problem two steps have been taken:

\begin{enumerate}
\item I have designed a mini font, that is still readable, but doesn´t
eat to much screen space.
\item You can temporarily enlarge or reduce the size of all on screen
text.
\end{enumerate}

A planned feature is a minimum zoom size for every text, where it
appears.

To make the map loading time more tolerable \IFmapper has a delayed
loading technique. Sections are only loaded when you edit
them\footnote{And when saving of couse}, so you can save time by
partitioning your map.

\section{Manual}

There still is no manual, you have to get by with these short notes.

\begin{figure}[ht]
  \begin{center}
    \epsfig{file=mapper2.ps}
    \caption{Map selection screen}
    \label{fig:mapsel}
  \end{center}
\end{figure}

\begin{description}
\item[Del]
      
  Deletes the selected map.

\item[New]
      
  Creates a new map. \IFmapper has a versioning system, so you don't
  have to add the number at the end. The versioning was added to avoid
  data loss during development and protection against user mistakes.

\item[Edit]

Starts the editing process

\item[Dump]
  
  This function exports the selected map in a version independent but
  less space efficient format. This was introduced as a safeguard
  against changes in the save file format in future versions of
  \IFmapper due to new features (this has already happened
  during development). I'm pretty sure I catched all the bugs in the
  Load/Save functions, but it is probably a good idea to dump your
  maps occasionally.
\end{description}

\begin{figure}[ht]
  \begin{center}
    \epsfig{file=mapper3.ps}\epsfig{file=mapper4.ps}
    \caption{Dumping and importing of maps}
    \label{fig:dump}
  \end{center}
\end{figure}

Dumped maps can be reimported via the menuitem


\begin{figure}[ht]
  \begin{center}
    \epsfig{file=mapper5.ps}
    \caption{Editing}
    \label{fig:edit}
  \end{center}
\end{figure}

For now you have to figure out for yourself how things
work. Just a few quick tips:

\begin{itemize}
\item Move mode is also for resizing.
\item All selected items are moved simultaneously, tap an item to
  toggle selection.
\item You can't move connections, the endpoints move with the
  locations.
\item Touch the pen close to the borders of the drawing areas and hold
  it there for scrolling. Watch out: the normal function is still
  performed, this can be especially confusing in move mode, when som
  offscreen items are still selected. My advice is to use edit mode
  for scrolling until you are a little more experienced.
\item Scrolling and zooming can be done via hardware buttons.
\end{itemize}

\section{ToDo}
The project was released under GPL, which is somewhat of a double
edged sword. You can look at the code and make whatever changes you
like, but on the other hand the responsibility for development is on
your head too. Even if you are not a programmer, you can contribute to
\IFmapper.

In no particular order:

\begin{description}
\item[Color support]
  
  I don´t have a color device and that won´t change for quite a bit.
  If you have a creative idea how to use color have a go.
\item[Manual] 

  This thing needs a complete manual.
\item[Maps] 

  At the moment some maps for Infocom games are included.
\item[Mini font] 

  The mini font is somewhat incomplete.
\item[Converters] 
  
  At least a converter to some printable format would be useful (ps or
  maybe xfig?) also to other mapping programs in as far as the
  features overlap. Maybe someone can come up with a generic xml DTD
  for maps.
\end{description}

\section{License}

\begin{enumerate}
\setcounter{enumi}{-1}
\item 
This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License.  The ``Program'', below,
refers to any such program or work, and a ``work based on the Program''
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language.  (Hereinafter, translation is included without limitation in
the term ``modification''.)  Each licensee is addressed as ``you''.

Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope.  The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.

\item You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.

You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.

\item You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:

\def\labelenumii{\alph{enumii})}
\begin{enumerate}
\item You must cause the modified files to carry prominent notices
    stating that you changed the files and the date of any change.

\item You must cause any work that you distribute or publish, that in
    whole or in part contains or is derived from the Program or any
    part thereof, to be licensed as a whole at no charge to all third
    parties under the terms of this License.

\item If the modified program normally reads commands interactively
    when run, you must cause it, when started running for such
    interactive use in the most ordinary way, to print or display an
    announcement including an appropriate copyright notice and a
    notice that there is no warranty (or else, saying that you provide
    a warranty) and that users may redistribute the program under
    these conditions, and telling the user how to view a copy of this
    License.  (Exception: if the Program itself is interactive but
    does not normally print such an announcement, your work based on
    the Program is not required to print an announcement.)
\end{enumerate}

These requirements apply to the modified work as a whole.  If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works.  But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.

In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.

\item You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:

\begin{enumerate}
\item Accompany it with the complete corresponding machine-readable
    source code, which must be distributed under the terms of Sections
    1 and 2 above on a medium customarily used for software interchange; or,

\item Accompany it with a written offer, valid for at least three
    years, to give any third party, for a charge no more than your
    cost of physically performing source distribution, a complete
    machine-readable copy of the corresponding source code, to be
    distributed under the terms of Sections 1 and 2 above on a medium
    customarily used for software interchange; or,

\item Accompany it with the information you received as to the offer
    to distribute corresponding source code.  (This alternative is
    allowed only for noncommercial distribution and only if you
    received the program in object code or executable form with such
    an offer, in accord with Subsection b above.)
\end{enumerate}

The source code for a work means the preferred form of the work for
making modifications to it.  For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable.  However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.

If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.

\item You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License.  Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.

\item You are not required to accept this License, since you have not
signed it.  However, nothing else grants you permission to modify or
distribute the Program or its derivative works.  These actions are
prohibited by law if you do not accept this License.  Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.

\item Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions.  You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.

\item If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all.  For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.

It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices.  Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.

This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.

\item If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded.  In such case, this License incorporates
the limitation as if written in the body of this License.

\item The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time.  Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

Each version is given a distinguishing version number.  If the Program
specifies a version number of this License which applies to it and ``any
later version'', you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation.  If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.

\item If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission.  For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this.  Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.

\bigskip
\centerline{NO WARRANTY}

\item BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.

\item IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
\end{enumerate}

\centerline{END OF TERMS AND CONDITIONS}
\cleardoublepage

\input main.tex
\input mapper.tex
\input db.tex
\input selectmap.tex
\input items.tex
\input draw.tex
\input util.tex
\end{document}
