GNU Info

(sc)The Built-in Header Rewrite Functions

---

Next: Electric References Prev: Reference Headers Up: Reference Headers

---

Enter node , (file) or (file)node

The Built-in Header Rewrite Functions
=====================================

   Below are examples of the various built-in header rewrite functions.
Please note the following: first, the text which appears in the
examples below as INFOKEY indicates that the corresponding value of the
info key from the info alist will be inserted there.  (Note:
Information Keys and the Info Alist).  For example, in
`sc-header-on-said' below, DATE and FROM correspond to the values of the
`Date:' and `From:' mail headers respectively.

   Also, the string `">>>>>"' below is really the value of the variable
`sc-reference-tag-string'.  This variable is used in all built-in
header rewrite functions, and you can customize its value to change the
tag string globally.

   Finally, the references headers actually written may omit certain
parts of the header if the info key associated with INFOKEY is not
present in the info alist.  In fact, for all built-in headers, if the
`From:' field is not present in the mail headers, the entire reference
header will be omitted (but this usually signals a serious problem
either in your MUA or in Supercite's installation).

`sc-no-header'
     This function produces no header. It should be used instead of
     `nil' to produce a blank header.  This header can possibly contain
     a blank line after the `mail-header-separator' line.

`sc-no-blank-line-or-header'
     This function is similar to `sc-no-header' except that any blank
     line after the `mail-header-separator' line will be removed.

`sc-header-on-said'
     `>>>>> On DATE, FROM said:'

`sc-header-inarticle-writes'
     `>>>>> In article MESSAGE-ID, FROM writes:'

`sc-header-regarding-adds'
     `>>>>> Regarding SUBJECT; FROM adds:'

`sc-header-attributed-writes'
     `>>>>> "SC-ATTRIBUTION" == SC-AUTHOR <SC-REPLY-ADDRESS> writes:'

`sc-header-author-writes'
     `>>>>> SC-AUTHOR writes:'

`sc-header-verbose'
     `>>>>> On DATE,'
     `>>>>> SC-AUTHOR'
     `>>>>> from the organization of ORGANIZATION'
     `>>>>> who can be reached at: SC-REPLY-ADDRESS'
     `>>>>> (whose comments are cited below with: "SC-CITE")'
     `>>>>> had this to say in article MESSAGE-ID'
     `>>>>> in newsgroups NEWSGROUPS'
     `>>>>> concerning the subject of SUBJECT'
     `>>>>> see REFERENCES for more details'