Alogorithms for the title


Up

There are various ways in which the title of an AmigaGuide node can be held in the file.

e.g. If a Node starts with the following...

@Node "Overview" "RunMPIndex.guide/Overview"
@Next "Installation"
@Prev "Main"
@Toc "Main"
@title RunMPIndex Quick Overview

Quick overview
**************

Then the following could be considered the title:

1 Overview
2 RunMPIndex.guide/Overview
3 RunMPIndex Quick Overview
4 Quick overview

Any @title 4 will be used if present.

If TITLE is supplied then 3 will be used.

If NODE2 is supplied then 2 will be used.

If NODE is supplied then 1 will be used.

However, if a duplicate title is produced in one file then there is a fallback from 4, to 3, to 2, to 1.

If none of TITLE, NODE2 and NODE are supplied then the mechanism of determining the title is guessed:

If makeinfo is found in the file before the first node then TITLE is assumed.

If the second node names of the second and third nodes are the same then NODE is assumed.

If any of the second node names of the fourth to the twentieth nodes include spaces then NODE2 is assumed.

If all of this fails then NODE is assumed.

This should hopefully produce valid titles on all guide files. If it does not then you can always override the guessing. Also please let me know of the file.