Review Foundry Review Engine User Manual YELLOW PAGE RECORDS

Adjust Text:  a a a a

« Table of Contents   |   Obtain Review Foundry »

• YELLOW PAGE RECORDS
• Creating a Yellow Page
• Editable Yellow Page Fields
• Editable Non-Yellow Page Fields
• Adding New Yellow Page Fields

YELLOW PAGE RECORDS

Yellow Pages are like Teams, in that they exist to categorize Suppliers in the same way that a Team categorizes its Members. Once you have created a set of Yellow Pages, Members can associate their Supplier accounts with one or more of these Yellow Pages, making it easier for other Members to find them. So Yellow Pages in Review Foundry are just like the Yellow Pages you find in other places, like the phone book or other internet listings of service providers. By being listed on a Yellow Page a Supplier can be reviewed and rated according to the rating attributes associated with the Yellow Page. How you define your Yellow Pages is entirely up to you. Yellow Pages are organized with the same kind of hierarchical structure that defines Categories and Teams: except for topmost Yellow Pages, each will have a parent Yellow Page to which it belongs, and each Yellow Page may be assigned an Editor who can handle reviews submitted on Suppliers belonging to that Yellow Page.

Once you have entered a Yellow Page into the Yellowpage table, and it has been allocated a Yellow Page ID of, say, 6, then you can navigate to the Yellow Page detail page via the browsable Supplier pages, or you can enter the URL to the Yellow Page detail page directly into your browser, like so:

http://www.mydomain.com/cgi-bin/path/to/...
	/foundry/do/reviews.cgi?module=find_supplier&yellowpage_id=8

Creating a Yellow Page

As with the other "Creating a Container" pages in this documentation, we cover here the procedure associated with adding a Yellow Page from the Database control panel, though you can also use the Yellow Page Browser in the admin area to create records. If you're not sure how to get to the Database control panel, see Creating a Category.

From the Database menu on the Database control panel, select "Add" for the action and "Yellowpage" for the table. Click on the submit button to have the right frame load. You'll then see the following form elements (example input values have been added for clarity, and are explained below):

Name
Subyellowpage of	-- --Root-- Football Accessories Baseball Accessories
Description	Trying to find Baseball Cards, Game Collectibles, and Signed Programs? Check out the suppliers in the Accessories area.
Keywords	Baseball, Baseball Cards, Collectibles, Signed Programs
Template Prefix
Image
Is Validated	Yes No
Invitation Only	No Yes

You can see that the input fields for this container are identical to the ones for the corresponding Category form, and differs from the corresponding Team form only in that the Invitation Only field appears in the latter form (giving you the opportunity to restrict Team enrollments to selected Members). For more information on the conceptual difference between Categories, Teams, and Yellow Pages see UNDERSTANDING THINGS & CONTAINERS.

Editable Yellow Page Fields

The following summary of the Yellow Page fields which appear both on the Add Yellowpage and Modify Yellowpage pages is mainly a rehash of the same information found in the corresponding section for Teams (but for purposes of self-containment, is presented here again). Note that the last 2 fields displayed above--Is Validated and Invitation Only--only appear when the Administrator or an Editor is logged in.

Name When you name a Yellow Page, you name it locally. That is, you provide the name of the Yellow Page relative to some parent Yellow Page. In the example, "Baseball Accessories" is the parent Yellow Page, and "Signed Programs" is the name of the new Yellow Page. The full name of the newly-created Yellow Page will be "Baseball Accessories/Signed Programs". Clearly, you cannot include a / in your Yellow Page name (as / is the Yellow Page delimiter), otherwise you will get an error message. The column is Yellowpage.name

Subyellowpage of
Each Yellow Page is either a topmost Yellow Page, or it has a parent Yellow Page. If you add a topmost Yellow Page, select "--Root--" for the value of the parent Yellow Page. Otherwise select the parent Yellow Page in which you wish to create your new Yellow Page. It is the ID of the parent Yellow Page which is actually stored, not the parent Yellow Page name itself. The corresponding column is Yellowpage.parent_id

Description
The Description for a Yellow Page is entirely optional. If defined, the description will appear beneath the Yellow Page breadcrumbs on pages which list either Yellow Pages, or the content of a Yellow Page. The description can also be toggled off from the Build / Browse frame of the Configure control panel. The column is Yellowpage.description

Keywords
The Keywords field is an optional string of comma-delimited words or phrases that will be used to populate metadata tags in the static version of the browsable Yellow Pages. Their purpose is thus to help spiders correctly index your web pages. This is a VARCHAR(255) column, meaning that the length of the field is limited to 255 characters. The column is Yellowpage.keywords

Template Prefix
The Template Prefix is an experimental column, not particularly recommended for use. If, for example, you supply the value "blue" for the Template Prefix (instead of leaving it blank) the 2 Yellow Page-related templates named find_supplier.ttml and find_supplier_list.ttml will NOT be processed in the usual way, and Review Foundry will look for the templates named blue_supplier.ttml and blue_supplier_list.ttml instead. Thus you would need to create these two new templates before attempting to use them. So if you really want to use a different set of templates for a given Yellow Page, this is one way to do it. The column is Yellowpage.template_prefix

Image
The Image field is optional and is based on an INT (integer) column which acts as a foreign key to the Upload table. To add an image to the Yellow Page record (it should be a small image which establishes a setting without pushing everything else around it out of place) you click on the button marked "Manage Upload" and a dialog box appears requesting information about the file to be uploaded. Once you have uploaded the image, a MIME icon and the name of the image file will appear on the Yellow Page record form itself, verifying that the image file is available before you even submit the Yellow Page record to the database. If you have enabled automatic image thumbnailing, a thumbnail of the uploaded image will also be stored along with the unscaled image. The column is Yellowpage.yellowpage_image

Is Validated
The Is Validated field toggles between "Yes" and "No". A Yellow Page will only appear on public pages if it is validated. The column is Yellowpage.is_validated

Editable Non-Yellow Page Fields

In addition to the Yellow Page fields shown above, there may be other non-Yellow Page fields which appear on the Add Yellow Page and Modify Yellow Page pages. The Administrator is able to modify the collection of rating attributes (or types) associated with a Yellow Page (which we term a Rating Template), so an extra form element will be present to handle this. As the form element is identical to the one shown in the corresponding section for Categories we'll just refer you to it instead of re-presenting it here: Editable Non-Category Fields. Each of the Container types, Category, Team, and Yellow Page use the same table to determine the elements of their Rating Template, namely the RatingType table, so the treatment is uniform for all Container types.

Notes relating to Editor assignment would be the same as those presented in the section for Editable Non-Category Fields with the exception that Editor assignment is carried out by directly loading the Add page for the YellowpageEditor table.

Adding Yellow Page Fields

If you need to add extra fields to the YellowPage table you can do this. For detailed information on the process of adding columns to existing tables, see ADDING COLUMNS TO A TABLE.

If you add columns which are used by some Yellow Pages and not others you can test for the column value before displaying it in any template which receives Yellow Page information. For example, if you add a Yellowpage.conditions column that you expect participating Suppliers to meet you can test with something like this:

	[% yellowpage = alias.yellowpage_info %]

	[% IF yellowpage.conditions %]
		PLEASE OBSERVE: [% yellowpage.conditions %]
	[% END %]

Note: in practice you will have to search for the relevant yellowpage hash to reference. It might, for example, be current_level.yellowpage_info which is buried in a yellowpage loop somewhere within one of the Template-Toolkit templates used for the browsable Yellow Pages.

« Table of Contents   |   Obtain Review Foundry »