Keywords: xcoral

Next: top-ten.sc Up: SmacLib Previous: sun-keydef.sc

# title.sc

This file contains some functions to automatically insert titles (file headers). The followings fields are included: File, Path, Description, Created, Author, Modified, Last maintained by, RCS revision, state, Note and copyright.

The three variables CopyrightFile, custom_organization, and custom_copyright are used to define the path of your complete copyright file, your organization and the abbreviation of your copyright (Example custom_copyright = "(c) Copyright 1994 Xcoral Galactic Company";). Their default values may be modified in the title.sc file, or set in the .xcoralrc or another .sc file.

When CopyrightFile is set to zero (default), the introduction of the GNU General Public License is inserted by title(), shell_title() and smac_title() functions.

The fields Created, Author, Modified, Last maintained by and copyright are automatically filled in at the function call.

The fields File, Path, Modified and Last maintained by are updated by the function update_title or when the file is saved if save.sc is used (see §5.32 page ).

The field RCS Revision State is updated with Smac RCS functions.

- void title(char* name); with foo as argument, inserts the following title:

- void shell_title(char* name); inserts the same title as the previous function but in shell comments (i.e. with a '`#`' at the beginning of each line).

- void custom_title(char* str); with foo as argument, inserts the following title:

- void custom_shell_title(char* str); inserts the same title as the previous function but in shell comments (i.e. with a '`#`' at the beginning of each line).

- void smac_title(); inserts the following title:

- void update_title(); updates the fields File, Path, Modified and Last maintained by.