Variable: vhdl-file-header

vhdl-file-header is a customizable variable defined in vhdl-mode.el.gz.

Value

"-------------------------------------------------------------------------------\n-- Title      : <title string>\n-- Project    : <project>\n-------------------------------------------------------------------------------\n-- File       : <filename>\n-- Author     : <author>\n-- Company    : <company>\n-- Created    : <date>\n-- Last update: <date>\n-- Platform   : <platform>\n-- Standard   : <standard>\n<projectdesc>-------------------------------------------------------------------------------\n-- Description: <cursor>\n<copyright>-------------------------------------------------------------------------------\n-- Revisions  :\n-- Date        Version  Author  Description\n-- <date>  1.0      <login>	Created\n-------------------------------------------------------------------------------\n\n"

Documentation

String or file to insert as file header.

If the string specifies an existing file name, the contents of the file is inserted, otherwise the string itself is inserted as file header. Type C-j for newlines. If the header contains RCS keywords, they may be written as <RCS>Keyword<RCS> if the header needs to be version controlled.

The following keywords for template generation are supported:
  <filename> : replaced by the name of the buffer
  <author> : replaced by the user name and email address
                  (user-full-name, user-mail-address)
  <authorfull> : replaced by the user full name (user-full-name)
  <login> : replaced by user login name (user-login-name)
  <company> : replaced by contents of option vhdl-company-name
  <date> : replaced by the current date
  <year> : replaced by the current year
  <project> : replaced by title of current project (vhdl-project)
  <projectdesc> : replaced by description of current project (vhdl-project)
  <copyright> : replaced by copyright string (vhdl-copyright-string)
  <platform> : replaced by contents of option vhdl-platform-spec
  <standard> : replaced by the VHDL language standard(s) used
  <... string> : replaced by a queried string ("..." is the prompt word)
  <title string>: replaced by file title in automatically generated files
  <cursor> : final cursor position

The (multi-line) project description <projectdesc> can be used as a project dependent part of the file header and can also contain the above keywords.

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/vhdl-mode.el.gz
(defcustom vhdl-file-header "\
-------------------------------------------------------------------------------
-- Title      : <title string>
-- Project    : <project>
-------------------------------------------------------------------------------
-- File       : <filename>
-- Author     : <author>
-- Company    : <company>
-- Created    : <date>
-- Last update: <date>
-- Platform   : <platform>
-- Standard   : <standard>
<projectdesc>-------------------------------------------------------------------------------
-- Description: <cursor>
<copyright>-------------------------------------------------------------------------------
-- Revisions  :
-- Date        Version  Author  Description
-- <date>  1.0      <login>\tCreated
-------------------------------------------------------------------------------

"
  "String or file to insert as file header.
If the string specifies an existing file name, the contents of the file is
inserted, otherwise the string itself is inserted as file header.
Type `C-j' for newlines.
If the header contains RCS keywords, they may be written as <RCS>Keyword<RCS>
if the header needs to be version controlled.

The following keywords for template generation are supported:
  <filename>    : replaced by the name of the buffer
  <author>      : replaced by the user name and email address
                  (`user-full-name', `user-mail-address')
  <authorfull>  : replaced by the user full name (`user-full-name')
  <login>       : replaced by user login name (`user-login-name')
  <company>     : replaced by contents of option `vhdl-company-name'
  <date>        : replaced by the current date
  <year>        : replaced by the current year
  <project>     : replaced by title of current project (`vhdl-project')
  <projectdesc> : replaced by description of current project (`vhdl-project')
  <copyright>   : replaced by copyright string (`vhdl-copyright-string')
  <platform>    : replaced by contents of option `vhdl-platform-spec'
  <standard>    : replaced by the VHDL language standard(s) used
  <... string>  : replaced by a queried string (\"...\" is the prompt word)
  <title string>: replaced by file title in automatically generated files
  <cursor>      : final cursor position

The (multi-line) project description <projectdesc> can be used as a project
dependent part of the file header and can also contain the above keywords."
  :type 'string
  :group 'vhdl-header)