Email this Page Log Support Call Send Feedback Print

Previous Topic

Next Topic

Book Contents

Book Index

Creating a TopicSearch Widget

Using the TopicSearch widget you can search the library using selected criteria and display the results on the home page. The widget can be used to display links to recently modified content, or commonly used books. The search criteria are defined in the default.layout file.

The following table lists the criteria that can be used by the TopicSearch.

Parameter

Value used in search

Text

Text string from the topic content.

ObjectCode

The object's code.

Description

The object's description.

BasedOn

The object template's code.

ObjectType

Search for objects of a specific type: AllTypes, Book, File, Glossary, HypertextLink, Index, IndexEntry, MacroProcedure, Media, Style, TableOfContents, TableOfFigures, TitlePage, Topic.

InBook

The book object's code.

ReleaseState

The release state name.

ResolveSubBooks

Resolve sub-books in search?

ModifiedFromDate

Search for objects modified after a specific date. Use the date format YYYY-MM-DD.

ModifiedToDate

Search for objects modified before a specific date. Use the date format YYYY-MM-DD.

ModifiedDaysAgo

Define the value as a number.

The search is defined by adding the required parameter to the code under the "parameters" section. Angle brackets are used to create opening and closing tags, which enclose the search value, for example, <ModifiedDaysAgo>7</ModifiedDaysAgo>.

Example:


      <HomePageControlInfo>
          <Title>Objects Modified in the Last 7 Days</Title>
          <Control>TopicSearch</Control>
          <Icon>/HPI/clock_reset.png</Icon>
          5</Position>
          <Width>370</Width>
          <Height>325</Height>
          <Parameters xsi:type="TopicSearchParameters">
              <ModifiedDaysAgo>7</ModifiedDaysAgo>
          </Parameters>
      </HomePageControlInfo>

To Create a WebDisplay Widget:

  1. Open the layout file.
  2. Create a new home page control info block between ControlInfo tags, starting and finishing with the HomePageControlInfo tags.
    • Add the widget name between the title tags.
    • Add Webdisplay for the widget type between the control tags.
    • Add the path to the image used in the title bar between the icon tags.
    • Add the page position, and the width and height dimensions (measured in pixels).
    • Add "TopicSearchParameters" as the type in the opening parameter tag.
    • Add the search parameters and value.
  3. Save your changes to the layout file.

See Also

Customizing the Author-it Live Home Page

Home Page Layout

Home Page Layout File

Creating Widgets

Creating a WebDisplay Widget

Creating a TopicDisplay Widget

Top of Page Email this Page Log Support Call Send Feedback Print