5.4. The path-map element

5.4. The `path-map` element

If all your pages are in the starting directory, or in first-level directories under that directory, you won't need a path-map element in your plan.xml file.

However, once your web starts to grow to the second level, you'll want to add a path-map element that defines the topic names for all the deeper directories. You can also give topic names to the first-level directories if you wish.

Continuing the plan.rnc schema, here is the definition of the path-map element. This element is a simple container for a set of topic elements, each of which defines one topic name.

plan.rnc

path-map = element path-map
{ topic*
}

topic = element topic
{ attribute topic-id { topic-id-pat },
  attribute path { text }
}
topic-id-pat = xsd:string { pattern='\i\c*' }

Attributes:

topic-id: The topic name you are defining. The pattern topic-id-pat specifies that the name must start with a name start character (such as a letter or underbar) followed by zero or more name characters (including all the name start characters plus digits).
path: The path to the directory containing the files for that topic, relative to the starting directory.

Here is an example of a path-map element with three topics:

  <path-map>
    <topic topic-id="canned" path="food/canned"/>
    <topic topic-id="cat-food" path="food"
    <topic topic-id="dry" path="food/dry"/>
  </path-map>

The first line says that files in topic canned will be found in the directory whose path, relative to the starting directory, is “food/canned”.

Building informational webs with PyStyler

5.4. The path-map element

5.4. The `path-map` element