#############################################
# URL SUBMITTER DOCUMENTATION               #
# Faisal Baloch                             #
# created on January 1st, 1999              #
#############################################

Thankyou for using the new URL SUBITTER. This documentation will help you understand how the new version works, and how to set it up. As you can see that URL SUBMITTER 3 is a little advanced then the old versions. It's much easier to upgrade the script since it uses external files and just one config file. That way you don't have to setup everything whenever a new version gets released. From now on there will be two versions for every one to download. The new user will have to download all the files but if you've used this script before you'll have to download the upgrade files. This system also helps us to update script incase a search engine changes it's settings. You should have these files in the zip, you download from our site:

urlsubmitter30.cgi --> the main script | unix: chmod 755
se 1,2,3.cgi  --> Search Engine Data files | unix: chmod
config.pl --> The configuration file | unix: chmod
mainhtml.cgi --> The html file in PERL format... This file contains the form and stuff
                 | unix: chmod
exaddon.cgi --> An example addon search engine (GALAXY) | unix: chmod
documentation.txt --> This File!!!

#############################################
#Detailed information about the files above #
#############################################
PLEASE NOTE: please don't change the file names or extensions when you put them on your server. This may cause the script to not function properly. Just unzip all the files and don't change any file's name. Read On!!!

urlsubmitter30.cgi: This file includes all the programming code. This file should be chmoded 755 so it can run. You don't have to set up anything in this file. Just make sure that the first line is pointing to Perl on your server. The only time you'll ever need to edit this file is when you'll be adding an addon. Read the Addons section in this file for help on how to add an addon.

se 1,2,3.cgi: These are the files that contain the search engine data. The main engine calls these files so it can put the searchengines on your screen. Each of these files contain 10 searchengines. Don't try to mess with this file as you might mess up the script. DON'T CHANGE THE FILENAME WHEN UPLOADING.

config.pl: This is the file that needs to be edited, the main engine will call this file to get all the settings. DON'T CHANGE THE FILENAME WHEN UPLOADING.

mainhtml.cgi: If you've used v2.0 or 1.0 before then it's quite easy for you to understand that this is the html page that shows up when you call the script. Don't try to change anything inside because it's not tottaly in HTML it's in PERL. So if you know PERL (and know what you're doing) then you can edit it so it looks somewhat like your website. The next update of this script will surely make it much easier to edit this file because we'll change it in HTML. DON'T CHANGE THE FILENAME WHEN UPLOADING.

exaddon.cgi: This is an example (fully functional) addon file for this script. This kinda shows you how to add an addon in our script. This makes total of 31 search engines in url submitter. If you want to get an idea on how to make an addon for yourself then you can open this file to get an idea on how to do it. for more information look in the addon section. again DON'T CHANGE THE FILENAME WHEN UPLOADING.
################################################################################################

###############
#ADDONS       #
###############
This section will give you a little information on how to add, delete and/or make an addon.

TO ADD AN ADDON: We'll use the exaddon.cgi for this part. (it's already loaded in the script).
Ok here goes: Open the script (The Engine). Scroll down Until you see a the section for addons. The addons section says : "ADD THE ADDONS HERE". scroll down a little and you should see "example addon file". Under that section it'll say "require "exaddon.cgi";" This is a PERL command to call and add the content of an external file. This is really simple but can messup the whole script if you don't put it right. That command basically tells the script to call the external addon file and include it in the script when it runs. Let's say that you have an addon file with the filename "myaddon.cgi". This is how you add it. You'll go in the script and do everthing I told you above. Once you see "require "exaddon.cgi";" then put this line under it:
"require "myaddon.cgi";"

I hope you see the difference, each time you want to add a file you should add another line similar to above but put the addons filename in the two "". Try it and see if your addon shows up on the addon page. if it doesn't then give us an email and we'll try to help.

TO DELETE AN ADDON: to delete an addon all you have to do is delete the line for the addon you added. For example if you want to delete an (make belive) addon called addon1234.cgi then you'll delete this line from the script: require "addon1234.cgi";. you can leave the addon on your server but deleting that line will stop showing/putting that addon in the script. It's that easy...

TO MAKE AN ADDON: Ok this section has (almost) everything you need to know to start making your own addons. This section assumes that you know PERL and that you've programmed in it. This section doesn't teach perl. If you're sure you know PERL then please proceed. Otherwise skip this part.

Tutorial: I've never created any tutorials before but here's my first attempt, hehehe.
The current versionn of URL SUBMITTER 3.0 is designed so you can only use addons of searchengines. May be v3.1 or 3.2... will contain the function to let you include other stuff in there. The first thing before even starting to think about making addons for our script and distributing them, you must contact FBwwo and ask for a special License code so you can distribute your addons to other people. If you're making them for personal use then you don't need to ask for this id.
This id is not only safe for you to distribute your (either free or commercial) addons but for us and the users, as it'll allow you to be in our list and also makes sure that every addon that you make makes it to our website so our users can download it and also visit your website.

If you're only making addons that are free then this code will be given to you for free. But if you're making commercial addons that you want to sell then you'll have to pay $5.00 for this code.

Tutorial 1: 
###########################################################
# Value Charts ############################################
###########################################################

Values for the form page:

Name      Value (in perl format)

name:        $fields{name}
email:       $fields{email}
title:       $fields{title}
url:         $fields{url}
address:     $fields{address}
address 2:   $fields{address2}
city:        $fields{city}
state:       $fields{state}
zip:         $fields{zip}
country:     $fields{country}
Description: $fields{description}
##############################################################


The above are the values that you'll need to know. These are the names of the values in the form page. $fields{value} is how you'll put the value as an perl. In addons all the values are hidden values. If you want to make a search engine addon first you need to go to their "add a url/site" page. Then look at the source(html code) of their page. Look for the form that is used for all the submission data. Let's say that, the search engine only has fields for "url" and "email". So you look in the source and find their values in the form that points to their submission script.
Let's say that this is the part about submitting the url and points to their submission script in the source code.

###############################################################################
<FORM ACTION="http://www.searchengine.com/cgi-bin/addurl.cgi" METHOD=POST>
<INPUT TYPE=TEXT NAME="website_url">
<INPUT TYPE=TEXT NAME="email">
<p><INPUT TYPE=SUBMIT NAME=Submit your url>
</FORM>
###############################################################################

Ok with common sense (and knowledge of HTML) you'll know that "website_url" is the value for the url/address to your page (http://www.blah.com)and "email" is the value for your email address. Once you figure that out now here comes the PERL programming part.

The format in which you should create your file is at the end of this section. Right now we worry about the programming(I don't like to say that word for such an easy part) part.

There are two, three ways to put a HTML code in Perl. One way that I use is the EOF format:

#######################################
PRINT<<EOF;
all the html and stuff goes here...
EOF
#######################################
So this is the format that we'll use through out this tutorial.
Once you gather all the information you need, you'll have to convert most of the (text...) values into hidden values and give them an already setup value. eg.$fields{value}
ok so you know that "website_url" is equal to "url"(look in the chart above)and "email" is equal to "email" (look in the chart above). Those two values are html values and we need to convert them in PERL values because that's what we're programming in right now. You don't really need to convert them because it's already done for you in the Main script and I've provided you with the perl values too(look in the chart above). So now you also know that "url" is equal to "$fields{url}" and "email" is equal to "$fields{email}". Once you know and understand all of that, now we need to acctually begin writing the Perl code.

##############
# Perl code  #
##############
PRINT<<EOF;
<FORM ACTION="http://www.searchengine.com/cgi-bin/addurl.cgi" METHOD=POST>
<INPUT TYPE=hidden NAME="website_url" value="$fields{url}">
<INPUT TYPE=hidden NAME="email" value="$fields{email}">
<P>
<INPUT TYPE="submit" VALUE="SUBMIT URL TO the search engine name">
</FORM>
<p><HR>
EOF
#############################################################################

Does the above code make sense and do you understand it?
If it does then that's good and you should keep on reading, if it doesn't then you should look through the turorial again and see if it makes sense...
Ok that's basically how you make the addon. There's not much work left now, all you need to do is apply the format that I'll give you at the end of the section. For now let's go with each line and see what each one means.

( <FORM ACTION="http://www.searchengine.com/cgi-bin/addurl.cgi" METHOD=POST> ) is the address where the submission script of the search engine is. You can get this copied directly off the source of the webpage.

( <INPUT TYPE=hidden NAME="website_url" value="$fields{url}"> )
( <INPUT TYPE=hidden NAME="email" value="$fields{email}">     )

 puts the value of the "url/email" that you submit from "url submitter 3.0" into a perl value "$fields{url}/$fields{email}" so when you press submit it automatically puts the the url and the email address in the form and converts it into HTML/TEXT...

<P>, </FORM>,<p>,<HR> these should always be included as shown above.

(  EOF  ) you must include this or you will mess up the whole script.

And That concludes our lesson. If you need help on anything or don't understand something then Email us and We'll try to help.
###############################################################################################

Addon Format: you must get your id before adding this formation in your addon. We'll put any addon that you send us on our website but it must be in this format and must include your id so we can know who's addon is it so we can give credit. This format is also basically tells the user that who's the author and information about their website and stuff.

###################
# FORMAT          #
###################
look in the addon provided with URL SUBMITTER 3.0 to get an idea what goes where...

######################################################
#NAME : title of this addon                          #
#Creater : Name/Company                              #
#Copyrighted company year-year                       #
#Website: url to your website                        #
#lis = your id                                       #
#Search Engine = name of the search engine           #
#addonnumber =  explained below                      #
#filename = name of the file                         #
######################################################

### ADD ON searchengine name FILE ###


Name: The title you gave the addon, For Example: My company's Addon File
Creator: You can either put your name or your company's name
if you have it copyrighted then put that after...
Website: Your website address, so people can check out your site.
lis: your id that we'll give you if you apply
Search Engine: the name of the search engine that this addon has.
addonnumber: You would put 1 here if this is your first addon, 2 if 2nd, 3 if 3rd.. and so on...
filename: what filename this addons under, For Example: myaddon.cgi, blahaddon.cgi...

That should be the basic formation of your addon.
Look in the example addon given with URL SUBMITTER v3.0
################################################################################################

#####################################
# Setting up the Config File        #
#####################################
This is how your configuration file looks like:

###############################################################################################
# URL to this script #
$path= "http://qbt25.hypermart.net/cgi-bin/urlsubmitter/urlsubmitter30.cgi";

# Enter the Background color (please add it in #XXXXXX form) default is White #
$background= "#FFFFFF";

# Enter the Title you want for the script #
$title= "!!FB URL SUBMITTER!!";

# Enter the Heading you want for the Script #
$header= "!!FB URL SUBMITTER!!";

# Enter the Title you want for the posting page #
$titlepost= "Submitting urls to the Search Engines";

# Enter the Header for the posting page
$headpost= "SUBMITTING URLS";

# Enter the Background color for the posting page(please add it in #XXXXXX form) default is White #
$backgroundp= "#FFFFFF";
#End Configure#

###############################################################################################

Let's take on line at a time and explain it so you know what to put in there...

# URL to this script #
$path= "http://qbt25.hypermart.net/cgi-bin/urlsubmitter/urlsubmitter30.cgi";

This line contains the URL to the fb url submitter script on your server. Change it! Or else it'll point to our site...


# Enter the Background color (please add it in #XXXXXX form) default is White #
$background= "#FFFFFF";

Change the #FFFFFF to the RGB color code you want... It's plain HTML. For Example: #FFFFFF is plain white. and #000000 is plain Black... Please consider one thing that the text color remains the same which is Black(we'll change this in future updates). So any dark color will make it really difficult to see the text.



# Enter the Title you want for the script #
$title= "!!FB URL SUBMITTER!!";

Change this to something like My sites Url Submitter... This will change the title on the first page of the script..


# Enter the Heading you want for the Script #
$header= "!!FB URL SUBMITTER!!";

Change this to something like My Sites Url Submitter.. This will change the Big letters on the First page...

# Enter the Title you want for the posting page #
$titlepost= "Submitting urls to the Search Engines";

You can either change it or leave it the same I don't care. This will change the title on the submission page.. (The page where all the buttons are for submitting to different search engines).


# Enter the Header for the posting page
$headpost= "SUBMITTING URLS";

You can either change it or leave it the same I don't care. This will change the Big letters on the submission page.. (The page where all the buttons are for submitting to different search engines).


# Enter the Background color for the posting page(please add it in #XXXXXX form) default is White #
$backgroundp= "#FFFFFF";

This will change the background color... Please don't make it really dark. I suggest you leave it the way it is.

ONE BIG BIG NOTE: PLEASE PUT ALL THE FILES IN THE SAME DIRECTORY IF YOU WANT THE SCRIPT TO WORK... YOU CAN MESS UP THIS SCRIPT JUST BY RENAMING THE FILES. SO DON'T RENAME ANYTHING AND PUT ALL THE FILES IN THE SAME DIRECTORY.

###############################################################################################
###############################################################################################
                                    FB URL SUBMITTER Documentation
                                               THE END!