Amiga ISO Collection/AmigaUtilCD1.iso/Database/X!-V330.LHA/VCArchive/makefilter/Filters.ReadMe

Text File | 1997-04-28 | 13.5 KB | 343 lines

          Video & CD-Archive -- Export-Filters
             Copyright: Harald Zottmann 1997




1) What is it all about
=======================

Since Version 3.30, the Video & CD-Archive is able to export
data to various different formats. It therefore makes use
of external Export-Filters, which can be written by the user.

With this installation, the Video & CD-Archive comes already
featuring a large number of different filter types:

  - ASCII format
  - LaTeX format
  - PostScript format
  - PageStream format





2) Write your own filter
========================

All Export-Filter files must reside in the directory "Filters" which
is located beneath the program directory of the Video & CD-Archive.
The Export-Filter names have various suffixes to distinguish between
them:

 .MC   for Tapes
 .PH   for Longplayers
 .CD   for Compact Discs
 .VI   for Video Tapes

Export-Filter files are pure ASCII files which can be created and
modified by every normal text editor. Control sequences are used to
tell the program what to do. Supported control sequnces so far are:

@TXT                write following ASCII text to export file
@BIN                write binary data to output file
@REPxyz@abc         replace sequence "xyz" with sequence "abc"
@%<format>s@xx@yy   write dataset row and column to export file


a) Example for ASCII text data:
-------------------------------

These rows define the beginning of a LaTeX document:

@TXT\documentstyle[german]{article}
@TXT\begin{document}
@TXT\footnotesize


This row defines a horizontal line that is used in conjunction with
the ASCII MC cover output:

@TXT|-------------------------------------------------------------------|


b) Example for binary data:
---------------------------

This row defines binary data in hexadecimal notation (00-ff) to
be written to the exported file:

@BIN 07 23 19 92 00 0d 02 00 00 00 e8 f8 00 01 49 7c 00 00 00 00


c) Example for replacements:
----------------------------

These rows define e.g. the standard replacement list for LaTeX
Export-Filters:

@REP\@ \(\backslash\)
@REP~@ \~\
@REP^@ \^\
@REP$@ \$
@REP{@ \{
@REP}@ \}
@REP%@ \%
@REP&@ \&
@REP#@ \#
@REP_@ \_
@REPä@\"a
@REPö@\"o
@REPü@\"u
@REPÄ@\"A
@REPÖ@\"O
@REPÜ@\"U
@REPß@\ss{}


d) Example for dataset output:
------------------------------

This row writes an `|` followed by row 14, starting with column 0
of the current dataset with a minimum printing width of 33 characters.
The format definition follows the syntax of the `C` programming language.
Then comes again the character `|` and row 14, starting this time with
column 34 of the current dataset. Note that in the MC and the CD case,
column 0 means the left part of the cover and column 34 identifies the right
part of the cover. The definition ends again with the character `|`:

@TXT|@%-33.33s@00@14@TXT|@%-33.33s@34@14@TXT|

See the Export-Filter files that come with this package for examples
and more details.





3) How to use the program `MakeFilter`
======================================


This program is intended to support you to create Export-Filters for
any third party program you like. I will explain the necessary steps
using PageStream as an example.

First of all you have to decide for what mode (MC, CD, Phono or Video)
you want to create a new Export-Filter. Let`s say that you want to create
a new MC cover design.

Start PageStream and import the ASCII file `MakeFilter.MC` which contains
necessary format definitions which is used by the program `MakeFilter` later on.
The sequences of this file represent some kind of placeholder for the real
datasets which will be inserted during export with the Video & CD-Archive.
You may change the position of these sequences by dragging them around or by
copy and paste, but don`t modify the sequences themself at all, not even delete
them partly.

You may now design the cover as you prefer it. You can use every feature
PageStream offers you, for example coloured lines, shaded text and so on.
You may even use cliparts in your cover design.

If you`ve finished your work, save the cover as a normal PageStream document.
In the directory `MakeFilter/PageStreamTemplates` there are some examples on
how these files may look like. You can also use these files and modify them
to your personal taste.

Now invoke `MakeFilter` with the shell command:


             MakeFilter <PageStreamFile> <ExportFilter.MC>


Note that PageStream uses a special character for the german `ß`. To implement
the conversion between the `ß` used by the Video & CD-Archive and the character
used by PageStream, you have to add the line:

@REPß@»

at the top of the resulting Export-Filter file. This command directs the export
function of the Video & CD-Archive to replace every `ß` of the exported dataset
to a special character known by PageStream.

Now copy the resulting file `ExportFilter.MC` to the `Filters` directory
beneath the program directory and invoke the Video & CD-Archive`s export
function from the main menu. Follow the steps described in the respective
section of the AmigaGuide file by pressing the `Help` key within the
Video & CD-Archive if you have problems here.

If everything went fine, you now can load the just exported file directly to
PageStream and print it.

Be aware that the procedure described above works only if the program you want
to design Export-Filters for (e.g. FinalWriter, PageStream etc.) saves its files
without changing the ASCII sequences of the format definitions file. That should
normally be the case, but you never know.




4) How it works
===============


MakeFilter is a pretty simple but nevertheless powerful tool. The way it works
is converting the unknown binary data of some document file to @BIN sequences
which are understood by the export function of the Video & CD-Archive.
Well, that would not help too much if there weren`t those placeholders inserted
in the document file, which are understood by MakeFilter and are replaced by

@%<format>s@xx@yy

sequences which in turn are understood by the Video & CD-Archive. See chapter 2
of this document for more information on those control sequences.

The placeholders which have to be imported and arranged somehow in the template
document, see chapter 4, have the following formats:



a) MC mode - MakeFilter.MC
--------------------------

@A0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@AF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@AG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@AH@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AI@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AJ@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@


b) CD mode - MakeFilter.CD
--------------------------

@A0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@A1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@A2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @B9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AH@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BH@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AI@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BI@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AJ@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @BJ@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@


c) Phono mode - MakeFilter.PH
-----------------------------

@A0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@A1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@A3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@A9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AC@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AD@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AE@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AF@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AG@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AH@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AI@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@AJ@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@


d) Video mode - MakeFilter.VI
-----------------------------

@A0@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

@A1@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C1@ @D1@@@@@
@A2@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C2@ @D2@@@@@
@A3@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C3@ @D3@@@@@
@A4@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C4@ @D4@@@@@
@A5@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C5@ @D5@@@@@
@A6@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C6@ @D6@@@@@
@A7@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C7@ @D7@@@@@
@A8@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C8@ @D8@@@@@
@A9@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @C9@ @D9@@@@@
@AA@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @CA@ @DA@@@@@
@AB@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @CB@ @DB@@@@@



Every sequence start with the character `@`, followed by two characters
which give the internal position of the dataset string. The first character
may have values from A...D, giving the x position:

 A --> 0    A-Side MC / Left-Side CD / Phono / Filmtitle-Field Video
 B --> 34   B-Side MC / Right-Side CD
 C --> 54   Time-Field Video
 D --> 59   Counter-Field Video

The second character defines the y position, giving the row of the dataset.
This one may have values from 0...9 and from A...J which means 10 to 19 then.

With this position information, a certain length information for the sequence
in question is included. MakeFilter checks the length of the sequences and
compares that information with internal settings. If it encounters possible
problems, it will give you detailed information on what might be incorrect.




5) What you might want to know now
==================================


Note that new Export-Filters will be made available on my personal WWW site:


              http://home.t-online.de/home/harald.zottmann


as soon as they are available. If you have written some new and really good
Export-Filters yourself, feel free to E-mail them to me in order to release
them on this site, or to get them included in a forthcoming release of the
program. As a reward for sending me Export-Filters which are worth to be
released, you may earn a free KeyFile for the Video & CD-Archive. Note that
I will distribute free KeyFiles only via E-Mail and only if I receive an
electronic copy of the ORDERFORM with the requested personal data from you.
The ORDERFORM file is included in the Video & CD-Archive program package.