MPQ Input Logo by Kable. email: kable@softhome.net
....
MPQ Input Manual / Instructions on creating Inspection Reviews
MPQ Input will create the HTML files used for the reviews. It will, hopefully, save you all the ball-ache of having to use a HTML editor. (This is just the normal manual with changes for Inspection Reviews).
..
Table of Contents
 #
Setting up MPQ Input. 
How to create a new review.
Viewing a created review.
Checking what reviews you've done.
Where to get the program from.
Credits.
..
Setting up MPQ Input. 
 #
First you will need the ins-pak.zip. This contains the graphics for the review table. Also here is how I suggest you set things up. Create a directory structure like this.
/inspection/images/
/inspection/css/
/inspection/levels/
/inspection/levels/mapname
The first two are created when you extract the zip file. All you need to do is create the "levels" directory. This is where the reviews should be stored. The "mapname" dir is the directory for where the pictures of a map are stored. This is different for each map.

Upon loading it you will have the main menu infront you. Simply click the Inspection Reviews button to start on a review.

Now on screen infront of you enter where some details into the Reviewer, Save Directory and File Extension boxes, located bottom right.

The default settings for this are c:\temp\ and .html. You probably need to change the Save Directory (make sure include a '\' at the end).

You will also need to enter your name and email address in the Reviewer box. You will need to enter TWO email addresses. One for each reviewer. Here is an example :
<a href="mailto:spin@b0rk.com">Spin</a>;<a href="mailto:treette@home.se">Wrath</a>
Now this is just HTML. The reason you put two in is because two appear in the final review. Also them MUST be separated by a ";". The program needs this so it can work out the where one email address finishes and the other one starts.

These settings are automatically saved to mpqinput.ini and with the review so theres no need to enter them every time you use the program.
 
How to create a new review.
 #
When you load the program up can automatically add a new review. Now since there is quite a bit of information to entered for an Inspection review there are four pages to go through. The first page contains the main details about the map, the author and reviewers. Basically its fairly self explanatory.

Pages Two to Four are all the text in the review. Page Two is for the Author Info, Architecture, Texturing and Lighting sections. Page Three is for the Walk Through, Gameplay and Conclusion sections. Page Four is for Excessus's famous little intros!

There is also a special tag that I've created, its <x></x>. This is to be put around text done by the second reviewer. When creating the HTML the program will automatically work out that this is the second reviewers text and change the colour of the writing. I've included several examples in the program, but here is one.

This is the text in the program :
<x>
Even though I think it some what lacks ammo, its still a good map purely for the fact that it looks different and offers a  much more interesting arena to play it. It is a very open map and offers a variety of different playing styles not seen in most Quake 2 maps.
</x>

Here is the output :
Even though I think it some what lacks ammo, its still a good map purely for the fact that it looks different and offers a  much more interesting arena to play it. It is a very open map and offers a variety of different playing styles not seen in most Quake 2 maps.

The tags must be on separate lines. The program just reads in lines at a time and looks for "<x>" and "</x>".

Then its simply a matter of taking the details from an email and pasting them in. Some boxes do require a certain type of input.

The Picture Caption boxes do not work. Maybe at a later date I will add support but currently entering text in them does nothing on the finished review file (the input is saved though).

You can also leave some boxes blank and the program will put in default values when creating the HTML file. Heres a list of which ones you can leave blank:


To create the HTML file hit the Create Review button. It also saves all the reviews you've done that session to a DAT file (text file). They are stored in Inspection.DAT in the directory you're running the program in.

If a DAT file exists the program will automatically load it up when it loads up. This means you can save the reviews you're working on and come back to them later.

After creating this initial review the button will become active and clicking the New Review button will start the process of making a review again.
 
Viewing a created review.
 #
Once you've saved the review, you can view it. To do this click the View Review button. This will take the filename of the HTML file and load up the review in your default HTML browser.

NOTE : If the review is already loaded up in a HTML browser, you'll have to Refresh/Reload the review in your browser.
 
Checking what reviews you've done.
 #
You probably create quiet a few reviews with the program. Now it can keep track of them and you can swop between them, say if you wanted to correct a review.

To check what reviews you've done click the Reviews Done button. This will bring up the screen shown below.

The listing is pretty simple. You have the date and time you last saved the review and the map name and author.

From here you can see what reviews you done and swop between them. To swop to another review you can double click on it on the list, or select it then click the button.

NOTE : Please make sure you've saved your work before swopping to another review, otherwise you will lose the review you currently have entered.
 
Where to get the program from.
Program:
http://www.planetquake.com/mpq/mpqinput/mpqinput.zip
Source code:
http://www.planetquake.com/mpq/mpqinput/mpqinput_src.zip
Inspection Pak:
http://www.planetquake.com/mpq/mpqinput/ins-pak.zip
 
Credits.
 #
Program and manual written by Paul Healey.
email: paulhealey@lineone.net

All Logos by Kable.
email: kable@softhome.net

Testing and Bug info : Monsto Brukes.
email: monsto@planetquake.com

Extra info from Agent Orange and Christian Katsch.