Jeanne's World    Apple Guide Place        Elko

Creating Elko Reports

Elko's Overview stack can generate a list of all the components used by any set of sequences. The report is recursive: that is, Elko looks in each listed sequence for its components, then looks in each subsequence and panel and includes their components, and so on. The result is a report of all the components your selected sequences rely on.

Creating a Report

You create reports on the first card of the Overview stack. The reports you make are also stored in the Overview stack.

When you import a sequence, its name is added to the list on the right. The left-hand column indicates (with a bullet) whether the sequence will be included in the report. You can mark a sequence for inclusion, or exclude it, by clicking the sequence name and then clicking Include or Exclude (or by clicking in the left-hand column). To include or exclude a set of sequences, shift-click or shift-drag to select the set you want, then click Include or Exclude. Select a sequence and click View to open the sequence's card.

To create a report, select the "of a set of sequences" radio button and mark the sequences to include. Then click Analyze to generate the report. Elko asks you for a report name. The process takes several minutes or more for an average-sized guide.

Viewing a Report

You view a report by clicking its name in the Reports list at the lower-left corner of the Overview window. (When you first create a report, Elko shows it automatically as soon as it's finished.)

The report screen shows all the components found. As in the other Elko stacks, you can click on any component to bring up its Elko entry. If one of the sequences requires a component that Elko couldn't find - for example, if a panel uses a "Huh?" sequence that's not in the Sequences stack - the component's name is marked with a diamond. This can be helpful in locating remaining references to sequences, panels, etc. that have been removed or renamed.

Four buttons at the upper right let you change the report:

• Update runs the analysis again (in case you have re-imported updated source files since the first analysis)
• Delete removes the current report from the stack permanently
• Show List displays the list of sequences you specified on the Overview card, so you can see which sequences are analyzed
• Print...you can probably guess what this does.

Other Report Types

Once you have created one or more sequence reports, you can create further reports based on them, using the other three radio buttons on the Overview card. When you click any of these buttons, a list of existing reports appears in place of the list of sequences. You select reports to be included in the analysis.

For example, suppose your guide contains the topic areas "Printing" and "Networks", and you've made a report of all the sequences in each of them: one for Printing and one for Networks.

• For a list of all the components these two topic areas have in common (the intersection), click "in each of a set of reports", then select your two reports from the list.
• For a list of all the components in either of these topic areas (the union), click "in any of a set of reports", then select your two reports.
• For a list of all components that are used in neither Printing nor Networks (the complement), click "not in a set of reports", then select your two reports.

You can select any number of reports.

Making an Index With Elko

Jeanne A. E. DeVoto jaed@jaedworks.com