Title

projix -- Index of project output files

Syntax

projix define

projix [compile] [using path_el]

Description

projix compiles an index of all output files for a project.
As it stands, "output files" means html files created with the out option or html command.

The index will have one row per project file, and as many columns as you define. A column definition has four parts:

1) a heading

2) cell text

3) 'tool-tip' text

4) a flag indicating that clicking on the cell should open the file

The following functions will produce file-specific info, when included in the cell or tool-tip text:

meta(title)

meta(revision)

meta(description)

path(start[,stop])

For example, the definition dataset:

heading cell tip link

Topic path(-2,-2)
Document meta(title) meta(desc) 1

would produce a 2-column index something like the following:

Topic Document

Important things Primus
Important things Secundus
Other things Another
Other things A Further
Trivial things grit in the gears

Column 1 (headed Topic) would show the name of the directory immediately holding the document;
Column 2 (headed Document) would show the document title from the metadata.
Hovering over a cell in column 2 would bring up a tool-tip with the document description, and clicking on a cell in column 2 would open the document in the browser
(that part isn't functional in this help file of course...).

projix define

projix define creates a dataset to hold the index definition, containing the variables heading, cell, tip, and link. Add 1 observation to the dataset for each desired column in the index. For link, any non-zero, non-missing value will make that column a clickable link to the file.

projix compile

projix compile creates the index file, in the current project directory using the definition dataset specified, or projix.dta in the current project directory by default.

The functions

The meta() functions simply replace themselves with the relevant metadata from the document. In particular, meta(title) is the metadata title, not the filename. But the filename can be retrieved with the path() function.

The path(start[,stop]) function defines a segment of the entire filepath to display, where start and stop are positive or negative integer offsets from the ends of the filepath.

For example, following are some functions and their results, using the filepath C:\a\b\e\file.ext.

Function Result

path(1,2) C:\a

path(2) a\b\e\file.ext

path(-1) file.ext

path(-2) e\file.ext

path(-2,-2) e