The Work Sets XML File

The file work-sets.xml defines all of the built-in (pre-defined) system work sets. The standard NU file is:

<?xml version="1.0" encoding="utf-8"?>
<WordHoardWorkSets>
   <addChildren title="Canterbury Tales: %t" id="cha-can">
      <exclude id="cha-can-title"/>
   </addChildren>
   <addChildren title="Faerie Queene: %t" id="spe-faq">
      <exclude id="spe-faq-title"/>
      <exclude id="spe-faq-ded"/>
   </addChildren>
   <addCorpus title="Spenser: Shorter Poems" id="spe">
      <exclude id="spe-faq"/>
   </addCorpus>
   <addCorpus title="Spenser: Shorter Poems (excluding SC)" id="spe">
      <exclude id="spe-faq"/>
      <exclude id="spe-sc"/>
   </addCorpus>
   <addTconViewCategories title="Shakespeare %t" id="sha" tconViewTitle="By Genre"/>
   <addAuthors title="Author: %t"/>
</WordHoardWorkSets>

The work sets definition file has the following elements:

• WordHoardWorkSets. The root element.

  Children:

  • addWorkParts (0..n). Adds a work set defined by a list of works and/or work parts.
  • addChildren (0..n). Adds a work set for each child of a work or work part.
  • addCorpus (0..n). Adds a work set for each work in a corpus.
  • addTconViewCategories (0..n). Adds a work set for each category in a table of contents view.
  • addAuthors (0..n). Adds a work set for each author.
  • addPeriods (0..n). Adds work sets for time periods.
• addWorkParts. Adds a work set defined by a list of works and/or work parts.

  Attributes:

  • title. Required work set title.

  Children:

  • include (0..n). Work or work part to be included in the work set.

  As an example, here's a definition of a work set titled "Hamlet and Othello":

  <addWorkParts title="Hamlet and Othello">
     <include id="sha-ham"/>
     <include id="sha-oth"/>
  </addWorkParts>
  	

• addChildren. Adds a work set for each child of a work or work part.

  Attributes:

  • title. Required work set title pattern. The placehoder "%t" in the pattern is replaced by the short title of the child.
  • id. Required parent work part id.

  Children:

  • exclude (0..n). Child work part to be excluded from the work set.
• addCorpus. Adds a work set for each work in a corpus.

  Attributes:

  • title. Required work set title pattern. The placehoder "%t" in the pattern is replaced by the short title of the work.
  • id. Required corpus id.

  Children:

  • exclude (0..n). Work to be excluded from the work set.
• addTconViewCategories. Adds a work set for each category in a table of contents view.

  Attributes:

  • title. Required work set title pattern. The placehoder "%t" in the pattern is replaced by the title of the table of contents category.
  • id. Required corpus id.
  • tconViewTitle. Required title of the table of contents view.
• addAuthors. Adds a work set for each author.

  Attributes:

  • title. Required work set title pattern. The placehoder "%t" in the pattern is replaced by the author name.
• addPeriods. Adds work sets for time periods.

  Attributes:

  • title. Required work set title pattern. The placehoder "%t" in the pattern is replaced by the year range for the time period.
  • id. Optional corpus id. If this attribute is specified, only works in the specified corpus are included. If this attribute is missing, all works are included.
  • start. Required start year.
  • end. Required end year.
  • increment. Required year increment. This is the size of each period.

  For example:

  <addPeriods title="Period: %t" start="1580" end="1640" increment="20"/>
  	

  Adds the following work sets:

  Period: 1579 or earlier
  Period: 1580-1599
  Period: 1600-1619
  Period: 1620-1639
  Period: 1640 or later
  	

• include. Work or work part to be included in a work set.

  Attributes:

  • id. Required id of the work or work part to be included.
• exclude. Work or work part to be excluded from a work set.

  Attributes:

  • id. Required id of the work or work part to be excluded.