The package supports single or muliple Broker/Agent sites. The configuration
file for each site is located in a plain text format and can be found at
{INSTALLATION_DIRECTORY}
/
{DISPLAYS_DIRECTORY}
/{DISPLAY_NAME}/display.inc. The DISPLAY_NAME is selected
when a Display is
defined
. If you have multiple Displays defined, there will be more than one directory
in the DISPLAYS_DIRECTORY. It is a good idea to keep a backup of
Display configurations in this directory.
This file has different sections that are used to divide configuration
information into logical groups:
- Handler
for integration with HTML
- Page Layout
Borders and layout information (thickness, color, backgrounds, etc.).
- Text Layout
Borders and layout information (thickness, color, backgrounds, etc.).
- Media Layout
Borders and layout information (thickness, color, backgrounds, etc.).
- Message
for messages that the consumer will see
Determining the settings that give you the look that you want will take a bit
of trial and error. There is a Preview Mode that can be used to see
the effect of these variables on the display.
|
Handler
This section controls settings that help the package interact with your
existing HTML applications. You can also extend the package by replacing these
routines with your own. You should note that these values are taken literally
therefore a value like "./index.php" is assumed to be relavent to the page you
are currently viewing. A value like "http://crt.realtors.org/index.php could
refer to a site that you don't operate. Remember, these are URLs not file
system locations.
- DETAIL_SEARCH_URL - The URL used to generate a detail view. If you
use the default, the LISTING_NUMBER_ARGUMENT will be required. This is a new
setting as of Version 1.1. Defaults to "./detail_search.php".
- GALLERY_SEARCH_URL - The URL used to generate a gallery view. If you
use the default, the LISTING_NUMBER_ARGUMENT will be required. This is a new
setting as of Version 1.1. Defaults to "./gallery_search.php".
- SUBMIT_SEARCH_URL - The URL used to take criteria and generate a
Summary View of the results. This is a new setting as of Version 1.1.
Defaults to "./submit_search.php".
- RETS_MEDIA_PROXY
- The code that will handle the delivery of images
to the browser. This is only relevant if the
MEDIA_LOCATION
parameter is set to "false". If MEDIA_LOCATION is set to "true", a direct URL
to images supplied by the RETS server will be used. If you want to capture
images or customize the image acquisition, override this with you own PHP
script. An interesting customization would be to mix images provided by the
service provider with "enhanced listing" images of your own. Defaults to
"./media_proxy.php".
- LISTING_NUMBER_ARGUMENT - The name of the argument that is used to
find listings via the HTTP protocol. You can safely set this to any string.
The string cannot contain spaces so use the underscore if you need to separate
words. Defaults to "listing_number".
|
|
|
Page Layout
This section contains settings that are used for all data elements, labels and
text information.
The following items control the FRAME and PANELS around all information
generated by the package. PANELS can hold either DATA (text) or MEDIA
(images).
|
|
- FONT_COLOR - The color of text. Use common HTML definitions of
color such as its name or hex value. Defaults to "#000000" (black).
- DATA_POINT_SIZE - The size, in points, of data elements returned
from the server. The value must end in "pt". Defaults to "10pt".
- HIGHLIGHT_FONT_COLOR - The color of highlighted, or error text.
Use common HTML definitions of color such as its name or hex value. Defaults
to "#ff0000" (red).
- SYSTEM_POINT_SIZE - The size of field descriptions, in "points".
The value must end in "pt". Defaults to "12pt".
- FONT_FACE - The style of font to use as a comma seperated list. The
first font that is found by the consumer's browser is used. Defaults to
"Verdana, Sans".
- FRAME_INSET - The spacing, in pixels, between the overall frame and
the information panels. This is shown as the space you see as yellow in the
diagram. Defaults to 6.
- FRAME_BORDER - The size, in pixels, of the border of the frame
around informations panels. The diagram has this set to 4. Defaults to 0
(no border).
- FRAME_BACKGROUND_COLOR - The backgound color to use for frame that
surrounds information panels. Use common HTML definitions of color (such as
its name or hex value) or a path to an image. The sample diagram has this set
to yellow. Defaults to "" (transparent).
- PANEL_INSET - The spacing, in pixels, between the border for a
panel and the information. This is shown as the space you see as light blue
in the diagram. Defaults to 6.
- PANEL_SPACING - The spacing, in pixels, between multiple items
contained on the panel (like DATA and IMAGES). Defaults to 6.
- PANEL_BORDER - The size, in pixels, of the border around the
information area. The information area can be DATA or IMAGES. The diagram
has this set to 4. Defaults to 4.
- PANEL_BACKGROUND_COLOR - The backgound color to use for panel that
surrounds information. Use common HTML definitions of color (such as
its name or hex value) or a path to an image. The sample diagram has this
set to light blue. Defaults to "#ffffff" (white).
- NAVBAR_BACKGROUND_COLOR - The backgound color to use for navigation
bars. Use common HTML definitions of color (such as its name or hex value) or
a path to an image. This setting is new as of Version 1.2. The sample diagram
has this set to light blue. Defaults to "ffffff" (white).
- NAVBAR_INSET - The spacing, in pixels, between the border for a
navigation bar and the buttons. This setting is new as of Version 1.2.
Defaults to 6.
- NAVBAR_SPACING - The spacing, in pixels, between buttons. This
setting is new as of Version 1.2. Defaults to 2.
- NAVBAR_BORDER - The size, in pixels, of the border around the
navigation bar. This setting is new as of Version 1.2. Defaults to 4.
|
|
|
Text Layout
These settings are used to define the spacing and colors of backgrounds for
information displayed by tha package. They are presented in the same order
as in the sample "config.inc" file.
The following items control a the layout of DATA PANELS (text) only.
|
|
- DATA_PANEL_INSET - The spacing, in pixels, between the border for
DATA information and the DATA information. This is shown as the space you
see as dark green in the diagram. Defaults to 6.
- DATA_PANEL_BORDER - The size, in pixels, of the border around
DATA information. The diagram has this set to 4. Defaults to 0.
- DATA_PANEL_BACKGROUND_COLOR - The backgound color to use for DATA
information displays. Use common HTML definitions of color (such as its name
or hex value) or a path to an image. The sample diagram has this set to dark
green. Defaults to "" (or transparent).
- DATA_SPACING - The spacing, in pixels, between multiple DATA items
contained on data panels. Defaults to 0.
- DATA_PADDING - The spacing, in pixels, between multiple DATA items
and the border. Defaults to 6.
- DATA_BORDER - The size, in pixels, of the border around DATA items.
The diagram has this set to 4. Defaults to 0.
- DATA_BACKGROUND_COLOR - The backgound color to use for each DATA
item. Use common HTML definitions of color (such as its name or hex value) or
a path to an image. The sample digram has this set to light green. Defaults
to "" (or transparent).
|
|
|
Media Layout
These settings are used to define the spacing and colors of backgrounds for
information displayed by tha package. They are presented in the same order
as in the sample "config.inc" file.
The following items control the layout of MEDIA PANELS (images) only.
|
|
- MEDIA_PANEL_INSET - The spacing, in pixels, between the border for
images and the images themselves. This is shown as the space you see as dark
green in the diagram. Defaults to 6.
- MEDIA_PANEL_BORDER - The size, in pixels, of the border around
images. The diagram has this set to 4. Defaults to 0.
- MEDIA_PANEL_BACKGROUND_COLOR - The backgound color to use for
images. Use common HTML definitions of color (such as its name or hex value)
or a path to an image. The sample diagram has this set to dark green.
Defaults to "" (or transparent).
- MEDIA_SPACING - The spacing, in pixels, between multiple images
contained on media panels. Defaults to 0.
- MEDIA_PADDING - The spacing, in pixels, between multiple images
and the border. Defaults to 6.
- MEDIA_BORDER - The size, in pixels, of the border around each image.
The diagram has this set to 4. Defaults to 0.
- MEDIA_BACKGROUND_COLOR - The backgound color to use for each image.
Use common HTML definitions of color (such as its name or hex value) or a path
to an image. The sample diagram has this set to light green. Defaults to
"" (or transparent).
- SUMMARY_IMAGE_WIDTH - The width to use for images on Summary Views.
This is a new setting as of Version 1.1. Defaults to "200".
- DETAIL_IMAGE_WIDTH - The width to use for images on Detail Views.
This is a new setting as of Version 1.2. Defaults to "300".
- DETAIL_SINGLE_IMAGE - A boolean (true or false) setting to only allow
single pictures to be displayed in Detail Views with links that allow traversal
to a Gallery Views. If this parameter is set to "false",then no Gallery View
will be available. This setting used to be called SINGLE_MEDIA before Version
1.2. Defaults to "true".
- GALLERY_IMAGE_WIDTH - The width to use for images on Gallery Views.
This is a new setting as of Version 1.2. Defaults to "300".
- MEDIA_DESCRIPTION - If the server supports the RETS
Content-Description header, set this value to "true". When set to "true" a
description of the image is provided by the service provider and it is
automatically displayed under the image. If a description is not provided but
this parameter is set to "true", no description will be generated. When set to
"false", no description will be generated for the image even if the server
supports the feature. This setting was located in the Source section prior to
Version 1.2. Defaults to "false".
|
|
|
Message
This section defined messages that the consumer will see if the package
encounters problems performing a task.
- NO_IMAGE_MESSAGE - The text to display in place of a picture if an
image is not found from the service provider. Defaults to "No Picture
Available".
- NO_ITEMS_MESSAGE - The text to display if a listings for a member
are not found. This may be related to the value given to the
OWNERSHIP_VARIABLE
setting presented in the Source Configuration file. This is new as of Version
1.1. Defaults to "No Listings were Found".
- NO_NUMBER_MESSAGE - The text to display if the package is invoked
without a listing number to look for. This may be related to the
LISTING_NUMBER_ARGUMENT
setting presented above. Defaults to "No Listing was Requested".
- NO_QUERY_MESSAGE - The text to display in if a poorly formed query
is sent to a search function. This is new as of Version 1.1. Defaults to "No
Criteria Specified".
- NO_SERVICE_MESSAGE - The text to display if the RETS server is not
operating or cannot be called. This is related to the settings in the
Connection
section of the Source Configuration file. Defaults to "This service is
temporarily not available".
- NOT_FOUND_MESSAGE - The text to display if the listing number is not
found. This may be related to the value given to the
LISTING_NUMBER_ARGUMENT
setting presented above. Defaults to "The Listing was Not Found".
- ENTER_QUERY_MESSAGE - The text to display at the bottom of the form
used to specify searches. This is new as of Version 1.2. Defaults to "Enter
Your Search Parameters Above".
- MORE_IMAGES_MESSAGE - The text to display at the bottom of a Detail
View if more images are avaialble througha Gallery View. This is new as of
Version 1.2. Defaults to "Click on Images for more Pictures".
|
|
|
|
|
