The star index
files can be viewed from the help menu of the ptlang and ptcl editors.
The star index files are updated when make sources
is run
in $PTOLEMY/src/domains
.
The program ptlang
converts .pl
files
In Ptolemy, stars are created from Ptlang
files, which have a .pl
suffix. In the Ptolemy
distribution, for each domain xxx the main built in stars are
in $PTOLEMY/src/domains/
xxx/stars
.
Some domains have other stars in
$PTOLEMY/src/domains/
xxx/
yyy/stars
.
The program ptlang
converts .pl
files
into .cc
and .h
files that are later
compiled. In addition ptlang
can produce HTML
documentation for the star. The makefiles are configured so that the
.html
file for a star foo.pl
ends up in
../doc/stars/foo.html
. The makefiles also have rules
that create an index of all the stars. The index file for a directory
is named starHTML.idx
. The makefiles create individual
starHTML.idx
files in each doc/stars
directory, and then merge the individual starHTML.idx
files into master starHTML.idx
files.
In addition, for each master starHTML.idx
file, a
file that contains a description of the sub-starHTML.idx
files is produced. This description is name
starHTML.idx.fst
and is in the Tycho Forest format. The
Index
Browser has been extended so that if the
starHTML.idx.fst
file is present, then a
Browse
button appears in the Index Browser.
For example, the CGC domain has the following star index files
$TYCHO/typt/lib/PtolemyFacets.fst
contains a visual description of the different Universes that Ptolemy
is shipped with. This file can be updated with the command cd
$TYCHO; make typt/lib/PtolemyFacets.fst
. To rebuild this file takes about an hour, as all the facets need to be opened.
The
nightly
rule in the same makefile will also rebuild this
file. Locally, at UC Berkeley, we have a nightly cron job that runs
the nightly
rule.
The BuilderDialog tool can also build this index.
$PTOLEMY/src/domains/domain.idx
is created by merging the domain.idx
files in each domain
directory.
ptlang
produces HTML file documentation for a star.
Each HTML files has a link at the bottom labeled StarName
users
. That link points to a location in the
domain.idx
file for the Ptolemy domain that the star is
in.
$PTOLEMY/src/domains/domain.idx
is generated by the
domain.idx
rule in $PTOLEMY/mk/domain.mk
. The
nightly
rule in $PTOLEMY/makfile
will also
rebuild this file.
The BuilderDialog tool can also build this index.
The directory $PTOLEMY/doc/star-demo-index
contains HTML files that contain list of stars and the
Ptolemy demos that the stars appear in. There is one file for each
domain.
This file is generated by cd $PTOLEMY/src/domains; make
starindex
.