Hallo,

be welcome to this template file. First thing you will note is that there is
nothing like a comment marker in this file's format. Instead there is a content
marking scheme.

To start let me note one thing. This BinPatch feature is new and not yet complete
and we are working on it to have it more complete day by day, please check back
to http://kayhayen.com for updates often.

When GenPatch or Click'n Patch creates a log file (ASCII in this case) it looks for the
combinations special content markers and parses what it finds inbetween them. You will
find a lot of them in this file. Their format is "<" followed by LOG a whitespace and
then the identfier internally known to the patch creator. It will complain if it does
not find certain content markers whereas in other cases it will not (e.g. when it does
not find the place to fill in the number of files for a content part).

We will normally document all allowed replacements when not used by default or when not
obviously recognizable. Please also note that the order of occurance for these placeholders
does not matter at all. You can rearrange it just as you like.

This is e.g. the main structure of the log file. The "Insert" refers to that text in this
items will be found as defined above elsewhere in the file. Exact position does not matter
to the patch creator though.

<LOGFILE>BinPatch Log File (ASCII version, use option -log=html for a HTML version)

<LOG Insert="LOG_PATCHEDFILES">
<LOG Insert="LOG_EMBEDDEDFILES">
<LOG Insert="LOG_SKIPPEDFILES">

Note: This log file format can be 99% customized. See template/logfile.txt for
the template being used. The file is self-explaining.

</LOGFILE>

The next item demonstrates dome kind of looping. It goes trough all the names of a list
of files of a certain type. We will allow additional marking to select sortings later on,
but for now there isn't.

<LOGITEM NAME="LOG_PATCHEDFILES">List Of Patched Files: <VALUE FROM="LIST_PATCHEDFILES" NAME="AMOUNT"> (these files are created using existing source files)

<FOREACH FROM="LIST_PATCHEDFILES" ITERATE="PATCH_INFO"><FOREACH FROM="PATCH_INFO:LIST_SOURCES" ITERATE="SOURCE_FILE"><VALUE FROM="SOURCE_FILE" NAME="RELPATH"> (<VALUE FROM="SOURCE_FILE" NAME="SIZE"> Bytes) -> </FOREACH><VALUE FROM="PATCH_INFO" NAME="RELPATH"> (<VALUE FROM="PATCH_INFO" NAME="SIZE"> Bytes)
</FOREACH>
----------------------------------------------------------------------------
</LOGITEM>


<LOGITEM NAME="LOG_EMBEDDEDFILES">List Of Embedded Files: <VALUE FROM="LIST_EMBEDDEDFILES" NAME="AMOUNT"> (not suiteable source files in all source state(s))
<FOREACH FROM="LIST_EMBEDDEDFILES" ITERATE="FILE_EMBEDDED">
<VALUE FROM="FILE_EMBEDDED" NAME="RELPATH"></FOREACH>
----------------------------------------------------------------------------
</LOGITEM>

<LOGITEM NAME="LOG_SKIPPEDFILES">List Of Skipped Files: <VALUE FROM="LIST_SKIPPEDFILES" NAME="AMOUNT"> (found identical in target and all source states)
<FOREACH FROM="LIST_SKIPPEDFILES" ITERATE="FILE_SKIPPED">
<VALUE FROM="FILE_SKIPPED" NAME="RELPATH"></FOREACH>
----------------------------------------------------------------------------
</LOGITEM>


If you have any suggestions or enhancements for this file, please feel free to
email them to suggestion@kayhayen.com and we will be glad to see if we can fit
your needs too.

	Greetings, Kay Hayen


