mySobek Home   |   Help
Skip Navigation Links.
MISSING BANNER
User Help >> Online System Administration >> Design Files >> Item Aggregation Design Files >> Static Browse and Info Pages

Static Browse and Info Pages

General Concept

Static browse and information pages under an item aggregation allow static html to be displayed within the context of a single item aggregation. The html source files for these appear in the item aggregation design folder. Browse pages appear as a tab in the list of different collection views, while information pages are somewhat hidden, and must be linked to either from a browse page or the home page of the item aggregation.

When used in conjunction with the item aggregation configuration file, multiple languages can be supported for browse and info pages.

For static info and browse files to be indexable by search engine robots, they must appear in the item configuraiton XML file.

Linking to Browse and Info Pages

To link to an item aggregation browse or info page from another page in this library, the URL query must be written in SobekCM syntax. To do this correctly, the BASEURL and aggregation code should be included, and either the <%?URLOPTS%> or <%&URLOPTS%> should also be included to ensure users do not lose some of their basic options, such as web skin and user language.

So, a complete link to a browse page with code partners for an aggregation abc will look like:

<a href="<%BASEURL%>AGGREGATIONCODE/partners<%?URLOPTS%>" >Partners Browse</a>

The html to link to an info page with code help for aggregation default will look like:

<a href="<%BASEURL%>default/help<%?URLOPTS%>" >Help Info</a>

Directory and Structure

While the item aggregation configuration file is recommended for these, the source files can be found during a directory scan if they are placed in the appropriate folders under the item aggregation html subfolder. For example, the browse files should end in either .html or .htm and be in the http://sobekrepository.org/design/[AggregationCode]/html/browse subfolder while the info pages should be under the design/[AggregationCode]/html/info subfolder.

An item aggregation configuration file (XML) defines all browse and info pages, and specifies their location. If an item aggregation configuration file is used, then the browse and info files can be placed anywhere under the item aggregation design folder.

Source File Header

Within the source files files, the following meta tags can exist in the header:

<meta name="banner" content="&lt;%BASEURL%&gt;design/aggregations/dloc/html/info/exhibitbanner.gif" />
<meta name="thumbnail" content="&lt;%BASEURL%&gt;design/aggregations/dloc/html/info/exhibitthumb.gif" />
<meta name="author" content="Sullivan, Mark" />
<meta name="date" content="March 8, 2010" />
<meta name="keywords" content="help pages, technical help, xml" />
<meta name="description" content="This contains any descriptive information..." />
<meta name="title" content="Browse and Info Static HTML Source Files" />
<meta name="code" content="infobrowse" />

These values will be read from within the <head> tag using an XML reader.

The following additional tags are also read:

  • <title> Browse and Info Static HTML Source File </title>
  • <code> infobrowse </code>

If no title is found in either the <meta name="title" /> or the <title> tag, then the grey box under the banner will not be included either.

SobekCM Directive Keywords

Several special directive keywords can be placed in the body of the source html file. These keywords will be replaced during runtime by the web application. Think of these as SobekCM-specific server side includes.

  • <%BASEURL%>
    This directive is replaced with the base URL for the current user's request. So, if the user comes through http://www.dloc.com, that is the base URL. Likewise, if the base URL for http://ufdc.uflib.ufl.edu/juv/all/brief/4 is http://ufdc.uflib.ufl.edu. Use this directive for all links within the digital library, to support access via multiple URLs.

    A link to return the user to their home link would be..
    <a href="<%BASEURL%><%?URLOPTS%>" title="Home">

    A link to send a user to a info page on their base url would be..
    <a href="<%BASEURL%>info/adminhelp/staticinfo<%?URLOPTS%>" title="Static Information">
  • <%?URLOPTS%>
    This directive is replaced with the current user's general options, which includes the user's current web skin, user interface language, etc. The encoded url options are preceeded with a question mark. This would be used for links which do not already have any query strings associated with it, such as..
    <a href="<%BASEURL%>info/adminhelp/staticinfo/<%?URLOPTS%>" title="Static Information">.

    Without this included, following one of your links may cause a user to lose their scope and settings.
  • <%&URLOPTS%>
    This directive is replaced with the current user's general options, which includes the user's current web skin, user interface language, etc. The encoded url options are preceeded with an ampersand. This would be used for links which already has query strings associated with it, such as search URLs..
    <a href="<%BASEURL%>juv/results/?t=kittens<%&URLOPTS%>" title="Canned Search">.

    Without this included, following one of your links may cause a user to lose their scope and settings.
  • <%URLOPTS%>     ( legacy directive )
    This directive is scheduled to be deprecated. It currently functions by putting the URL Options but excludes any leading character ( ? or & )
  • <%WEBSKIN%>, or <%INTERFACE%>
    These directives are replaced with the web skin code for the current user's web skin ( such as 'sample' ). This can be useful for addressing some design elements which may exist in every web skin's design folders.
  • <%TABSTART%> and <%TABSTART%>
    These draw downward tabs in the current web skins design. This is useful for adding tabular navigation under the banner or title box.

    For example the html '<%TABSTART%> TEST <%TABEND%>', is replaced with TEST during runtime rendering.
  • <%SELECTED_TABSTART%> and <%SELECTED_TABEND%>
    These draw the selected downward tabs in the current web skins design. This is useful for adding tabular navigation under the banner or title box which should include highlighting of the currently selected tab.

    For example the html '<%SELECTED_TABSTART%> TEST <%SELECTED_TABEND%>', is replaced with TEST during runtime rendering.

Text Indexing

( Pending Additional Development )

When the text indexes are built for a collection, the info and browse pages for collections and subcollections under the group will be indexed. The full text will be the full text of the browse (with an attempt to remove all html tags) and the values in the meta tags will be used for the appropriate metadata fields. These will appear in the result sets, just like other items.