Overview of the Library.xml File

The Library.dtd file defines the legal building blocks for the PPM Documentation Library "home" page.

The structure of the XML is as follows:

  • Sections. Information is presented in two columns, using the left and right portions of the page.

    This data uses the <leftsection> and <rightsection> elements.

    Each section must include at least one group.

  • Groups. Collections of related documents can be grouped in the left or right half of the page (such as General Interest or Configuration Guides as shown in Figure 4-1. Library documents).

    This data uses the <group> element.

    A group is composed of:

    • Heading (using the <head> element)

      • Heading title (using the <htitle> element)

      • (Optional) Heading description (using the <hdesc> element)

    • (Optional) One or more subheadings (using the <subhead> element)

      • Subheading title (using the <stitle> element)

      • (Optional) Subheading description (using the <sdesc> element)

    • At least one document element.

  • Documents. Titles and links that specify product documents (such as Getting Started and Customizing the Standard Interface) are presented within groups.

    This data relies on the <document> element.

    A document is composed of:

    • Document title (using the <dtitle> element)

    • Document file name (using the <dfn> element)

      Specify the path of the file relative to the pdf directory (see Where to Find the Files for details on the PPM Server file organization).

    • (Possibly optional) Document type (using the <dtype> element)

      If the file format is not PDF, the file format must also be included (see Supported File Types for details).

      If the file format is HTML (or HTM), also see the HTML link description.

    • (Optional) HTML link (using the <dhtm> element)

      Specify the path of the file relative to the pdf directory—this should mimic the text found within an HTML href attribute.

      Use of this element makes the document's title appear as a hyperlink (instead of a linked icon). This is typically used when your document is available in both HTML and another format (such as PDF). In this event, include the <dfn>, <dtype>, and <dhtm> elements. The document will be displayed once, with the title hyperlinked to the HTML file and the applicable icon linked to the alternatively formatted file.

      If your document is available in only HTML format, specify NONE (in upper case) for the document file name (the <dfn> element), and then use the <dhtm> element to specify the file to be linked to the document title.

    • (Optional) Dates (using either the <dpub> or <dupd> element)

      These dates are composed of:

      • Month (using the <month> element in two-digit, numeric format)

      • Day (using the <day> element in two-digit, numeric format)

      • Year (using the <year> element in four-digit, numeric format)

      For example:

      <dpub>
      <month>08</month>
      <day>19</day>
      <year>2009</year>
      </dpub>

      These are provided so that you can either specify the date when the document was "published" on your site, or the date it was "updated" on your site.

      When either of these dates is within 30 days of the date on the client system, the NEW icon appears next to the entry for that document. To prevent stale data from being displayed when advising your users that there is new information, the NEW icon does not display after 30 days have elapsed (relative to the date on the client system).

For your convenience, the Library.dtd file is included in Sample Files. Minimally, the XML content for this Web page must include at least one group in each section (left and right), and at least one document must be included in each group.