next up previous 62
Next: Internal workings
Up: Browsing using HTML
Previous: Locating a source file


Viewing a source file

A file from a package is normally presented as text in the browser. If it is C or Fortran source code, then each call of a function or subroutine should be a hyperlink to the appropriate definition. Similarly, included files (Fortran INCLUDE or C #include) are hyperlinked to the right place. If any part of the source text is in bold face, this indicates that it ought to be a link, but that the routine or file in question cannot be found. This can happen because the program has misinterpreted the source code, or the index is out of date, or for other reasons. The program tries to link to the correct place, but cannot guarantee to do so; for instance if there are two routines with the same name in different packages outside the package containing the current file, the link might point to the wrong one. Most types of file other than C or Fortran source are simply presented as plain text, although some types (e.g. postscript) will be presented using a viewer appropriate to the type.

The title of the HTML document (normally displayed in the title bar of your browser) is the location of the file in the source tree. The notation is specific to this package, but quite easy to understand: it's like a Unix pathname except that a `#' sign denotes inclusion in a package, and a `>' sign denotes inclusion in a tar file. So for instance the location

figaro#figaro_dsa.tar>dsa/dsa_dat_sz.f
means that the file is part of the package FIGARO, is contained in the tar archive figaro_dsa.tar, and within that archive is called dsa/dsa_dat_sz.f.

At the bottom of each file is a copyright notice, a link to the list of all items in the current file's package, and a link to the top level of the browser.



next up previous 62
Next: Internal workings
Up: Browsing using HTML
Previous: Locating a source file

SCB --- Source Code Browser
Starlink User Note 225
M. B. Taylor
10 December 1999
E-mail:ussc@star.rl.ac.uk