![[Table of Contents]](/dwicons/b_toc.gif)
|
|
DynaWeb Publishers Guide |
![[-]](/dwicons/i_colpse.gif)
| 5. Modifying The DynaWeb Interface |
|
| The Preferences Dialog |
DynaWeb 4.1 adds a Preferences Dialog, where users can modify some of the settings of the server through an HTML form. This section details how user preferences are stored and how the default values for the settings can be modified.
When a user accesses a DynaWeb server, DynaWeb provides a Preferences button on the button bar which the user can select. This button brings up an HTML form that presents the user with options for modifying the server behavior, such as background colors, TOC sorting after searches, query expansion options, and others. Setting any of these preferences causes the preference data to be stored on the client side with a cookie. Anytime the server is accessed, DynaWeb attempts to gather the preference data from the cookie. If no cookie is found, the values are taken from the stored, default parameter map sourced at server startup. This parameter map is located in the pubpref.dwc configuration file and sourced in by the dynaweb.dwc configuration file.
Throughout the DynaWeb scripts and templates is a new command, called dwGetPref. This command retrieves the preferences from either the parameter map (if not cookie has been set) or from the global variable as set in preproc.dwc. For example, the background color for the Content pane was previously hard-coded into the source. Now, the HTML looks like the following:
<BODY BGCOLOR=$[dwGetPref BGColor] ...
When DynaWeb constructs the template, it gets the value from the preference parameter map and replaces BGColor with the value.
The following table illustrates the configuration files used to set up the preference parameters.
| Configuration File | Role |
| dynaweb.dwc | At startup, procdef.dwc reads in the default values and sets up the default parameter map. |
| preproc.dwc | When the request is received, preproc.dwc checks to see if any preference cookie exists. If so, the values from the cookie are stored in global variables. Any values that are not specified by the cookie are taken from the default parameter map by dwGetPref. |
| pubpref.dwc | The pubpref.dwc file holds all of the default values for the parameter settings. At startup, the dynaweb.dwc file reads in the values and stores them in a parameter map. |
| prefs.dwc | This file contains the HTML used to create the page where the user can edit their preferences. |
| bookbbar.dwc bookprnt.dwc booktext.dwc booktoc.dwc bookutil.dwc collbbar.dwc colltext.dwc colltoc.dwc prefs.dwc preproc.dwc procdef.dwc rootview.dwc tocutil.dwc | All of these configuration files call dwGetPref. |
The following table explains the different variable names in the preference parameter map, what preference each one corresponds to, and what the default value is.
| Parameter Name | Preference | Default Value | Possible Values |
| UseDynamicToolTips | Dynamic Tool Tips | 1 | 0 or 1 |
| ShowUpperMiniTocsMode | Show Upper Mini TOC | noFrames | never noFrames always |
| ShowLowerMiniTocsMode | Show Lower Mini TOC | noFrames | never noFrames always |
| MaxPageBytes | Maximum Page Bytes | 30000 | 0-[MaxInt] "unlimited" |
| ButtonsAroundHits | Buttons Around Hits | 0 | 0 or 1 |
| SortByHits | Sort By Hits | 0 | 0 or 1 |
| Elision | Filtering | 1 | 0 or 1 |
| HitColor | Hit Highlight Color | Red | Any value of colorList |
| BBarColor | Button Bar Color | Silver | Any value of colorList |
| BGColor | Background Color | #FFFBF0 | Any value of colorList |
| Language | Language | EN | EN, JA, FR, IT, DE, ES |
| EN_Thesaurus | English Thesaurus Usage | 1 | 0 or 1 |
| EN_Stemming | English Stemming Usage | 1 | 0 or 1 |
| EN_PubThesaurus | English Publisher's Thesaurus Usage | 1 | 0 or 1 |
| EN_Compound | English Compounding Usage | 1 | 0 or 1 |
| EN_Normalize | English Text Normalization Usage | 1 | 0 or 1 |
| EN_MaxInputTermsToMatch | Maximum Input Terms to Match per query | 100 | 1 - 5000 |
| EN_MaxExpTermPerInputTerm | Maximum Expansion Terms to return per Input Term | 50 | 1 - 500 |
| EN_MinSOA | Minimum Strength of Association | 50 | 0 - 100 |
| FR_Thesaurus | French Thesaurus Usage | 1 | 0 or 1 |
| FR_Stemming | French Stemming Usage | 1 | 0 or 1 |
| FR_PubThesaurus | French Publisher's Thesaurus Usage | 1 | 0 or 1 |
| FR_Compound | French Compounding Usage | 1 | 0 or 1 |
| FR_Normalize | French Text Normalization Usage | 1 | 0 or 1 |
| FR_MaxInputTermsToMatch | Maximum Input Terms to Match per query | 200 | 1 - 5000 |
| FR_MaxExpTermPerInputTerm | Maximum Expansion Terms to return per Input Term | 50 | 1 - 500 |
| FR_MinSOA | Minimum Strength of Association | 50 | 0 - 100 |
| IT_Thesaurus | Italian Thesaurus Usage | 1 | 0 or 1 |
| IT_Stemming | Italian Stemming Usage | 1 | 0 or 1 |
| IT_PubThesaurus | Italian Publisher's Thesaurus Usage | 1 | 0 or 1 |
| IT_Compound | Italian Compounding Usage | 1 | 0 or 1 |
| IT_Normalize | Italian Text Normalization Usage | 1 | 0 or 1 |
| IT_MaxInputTermsToMatch | Maximum Input Terms to Match per query | 200 | 1 - 5000 |
| IT_MaxExpTermPerInputTerm | Maximum Expansion Terms to return per Input Term | 100 | 1 - 500 |
| IT_MinSOA | Minimum Strength of Association | 50 | 0 - 100 |
| DE_Thesaurus | German Thesaurus Usage | 1 | 0 or 1 |
| DE_Stemming | German Stemming Usage | 1 | 0 or 1 |
| DE_PubThesaurus | German Publisher's Thesaurus Usage | 1 | 0 or 1 |
| DE_Compound | German Compounding Usage | 1 | 0 or 1 |
| DE_Normalize | German Text Normalization Usage | 1 | 0 or 1 |
| DE_MaxInputTermsToMatch | Maximum Input Terms to Match per query | 200 | 1 - 5000 |
| DE_MaxExpTermPerInputTerm | Maximum Expansion Terms to return per Input Term | 100 | 1 - 500 |
| DE_MinSOA | Minimum Strength of Association | 50 | 0 - 100 |
| ES_Thesaurus | Spanish Thesaurus Usage | 1 | 0 or 1 |
| ES_Stemming | Spanish Stemming Usage | 1 | 0 or 1 |
| ES_PubThesaurus | Spanish Publisher's Thesaurus Usage | 1 | 0 or 1 |
| ES_Compound | Spanish Compounding Usage | 1 | 0 or 1 |
| ES_Normalize | Spanish Text Normalization Usage | 1 | 0 or 1 |
| ES_MaxInputTermsToMatch | Maximum Input Terms to Match per query | 200 | 1 - 5000 |
| ES_MaxExpTermPerInputTerm | Maximum Expansion Terms to return per Input Term | 100 | 1 - 500 |
| ES_MinSOA | Minimum Strength of Association | 50 | 0 - 100 |
| JA_Thesaurus | Japanese Thesaurus Usage | 0 | 0 or 1 |
| JA_Stemming | Japanese Stemming Usage | 1 | 0 or 1 |
| JA_PubThesaurus | Japanese Publisher's Thesaurus Usage | 1 | 0 or 1 |
| JA_Compound | Japanese Compounding Usage | 1 | 0 or 1 |
| JA_Normalize | Japanese Text Normalization Usage | 1 | 0 or 1 |
| JA_MaxInputTermsToMatch | Maximum Input Terms to Match per query | 1000 | 1 - 5000 |
| JA_MaxExpTermPerInputTerm | Maximum Expansion Terms to return per Input Term | 250 | 1 - 500 |
| JA_MinSOA | Minimum Strength of Association | 50 | 0 - 100 |
| BookLevel_ContentStylesheet | Content Stylesheet | "default" | available book-level stylesheets |
| BookLevel_TocStylesheet | TOC Stylesheet | "default" | available book-level stylesheets |
The "colorlist" Setting
In the pubpref.dwc file, the colorlist parameter specifies the colors that will be shown in the drop-down list of colors for the background, button bar, and search hits. The colors listed are the standard Windows colors that browsers understand.
|
|