mySobek Home   |   Help
Skip Navigation Links.
MISSING BANNER
User Help >> Online System Administration >> Design Files >> Item Aggregation Design Files >> Home Page Source Files

Home Page Source Files

General Concept

The text (and html) included in the home page are read from a html source file which is found under the item aggregation design folder.

Directory and Structure

If no aggregation configuration file exists, the files must be named text.html. If home page text for multiple languages are included, the language code should appear in the name, such as text_[Language_Code].html.
( i.e., text_es.html or text_fr.html )

In the absence of the aggregation configuration file, these files must appear in the html/home subfolder under the item aggregation design folder.

Source File Header

No data is read from the html header in the source file, but header information can be included without interfering with anything. Likewise, it is not necessary to include any of the standard html structure tags ( i.e., <html>, <body>, <head> ). If any are included, however, be sure to include the beginning of the body tag ( i.e., '<body>' ) and everything prior will be excluded. Likewise any subsquent appearance of '</body>' and '</html>' will be removed.

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.

  • <%PAGES%>
    This will be replaced with the number of pages in the current item aggregation.
  • <%ITEMS%>
    This will be replaced with the number of items in the current item aggregation.
  • <%TITLES%>
    This will be replaced with the number of titles in the current item aggregation.
  • <%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 <%TABEND%>
    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 home pages for collections and subcollections under the group will be indexed. The full text will be the full text of the home page (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.