diff options
Diffstat (limited to 'contrib/mom/momdoc/letters.html')
| -rw-r--r-- | contrib/mom/momdoc/letters.html | 609 |
1 files changed, 0 insertions, 609 deletions
diff --git a/contrib/mom/momdoc/letters.html b/contrib/mom/momdoc/letters.html deleted file mode 100644 index d06c8cfd..00000000 --- a/contrib/mom/momdoc/letters.html +++ /dev/null @@ -1,609 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- -This file is part of groff, the GNU roff type-setting system. - -Copyright (C) 2004, 2005, 2006, 2009 Free Software Foundation, Inc. -Written by Peter Schaffter. - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with the -Invariant Sections being this comment section, with no Front-Cover -Texts, and with no Back-Cover Texts. - -A copy of the Free Documentation License is included as a file called -FDL in the main directory of the groff source package. ---> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<meta http-equiv="content-type" content="text/html;charset=iso-8859-1"/> -<title>Mom -- Document Processing, Writing Letters</title> -</head> -<body bgcolor="#dfdfdf"> - -<!-- ==================================================================== --> - -<a name="TOP"></a> - -<p> -<a href="macrolist.html#TOP">Next</a> -<a href="refer.html#TOP">Prev</a> -<a href="toc.html">Back to Table of Contents</a> -</p> - -<a name="LETTERS"><h1 align="center"><u>Writing letters with mom</u></h1></a> - -<a name="LETTERS_INTRO"><h2><u>Introduction</u></h2></a> - -<p> -<strong>Mom</strong>'s simple but effective letter-writing -macros are a subset of the -<a href="docprocessing.html#DOCPROCESSING">document processing macros</a>, -designed to ease the creation of correspondence. -</p> - -<p> -Because the letter macros are a subset of the document -processing macros, you can use -<a href="definitions.html#TERMS_CONTROLMACRO">control macros</a> -to design correspondence to your own specifications. However, -<strong>mom</strong> makes no pretence of providing complete design -flexibility in the matter of letters, which are, after all, simple -communicative documents whose only real style requirements are that -they be neat and professional-looking. -</p> - -<hr width="66%" align="left"/> - -<p> -<a name="TUTORIAL"><h2><u>Tutorial on writing letters</u></h2></a> -</p> - -<p> -<strong>Mom</strong> letters begin, like all -<strong>mom</strong>-processed documents, with a -<a href="docprocessing.html#REFERENCE_MACROS">reference macro</a> -(in this case, -<a href="docprocessing.html#AUTHOR">AUTHOR</a>), -a -<a href="docprocessing.html#DOCTYPE">DOCTYPE</a> -(<strong>LETTER</strong>, obviously), the essential -<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a> -macro, and -<a href="docprocessing.html#START">START</a>, -like this: - -<pre> - .AUTHOR "Yannick P. Guique" - .DOCTYPE LETTER - .PRINTSTYLE TYPESET - .START -</pre> -</p> - -<p> -<strong>PRINTSTYLE</strong>, above, could also be -<strong>TYPEWRITE</strong>. <strong>Mom</strong> has no objection to -creating letters that look like they were typed on an Underwood by a -shapely secretary with 1940s gams. -</p> - -<p> -After the <strong>START</strong> macro, you enter headers pertinent -to your letter: the date, the addressee (in business correspondence, -typically both name and address), the addresser (that's you; in -business correspondence, typically both name and address), and a -greeting (in full, e.g. "Dear Mr. Smith," or "Dear -Mr. Smith:"). -</p> - -<p> -The macros for entering the headers are simple (they're not even -<a href="definitions.html#TERMS_TOGGLE">toggles</a>): - -<pre> - .DATE - .TO - .FROM - .GREETING -</pre> -</p> - -<p> -You may enter them in any order you like, except for -<strong>GREETING</strong>, which must come last. -<strong>Mom</strong> ignores any headers you omit and spaces the -letter's opening according to what you do include. See -<a href="#LETTERS_DEFAULTS">Default for letters</a> -to find out how <strong>mom</strong> formats the headers. -</p> - -<p> -(In pre 1.1.7-a releases of <strong>mom</strong>, the order -of entry was fixed at the above. This has been changed, although -if you do follow the above order, <strong>mom</strong> will -continue to behave exactly as she did in pre 1.1.7-a.) -</p> - -<p> -Once you've filled in what you need to get a letter started, simply -type the letter, introducing each and every paragraph, including -the first, with the -<a href="docelement.html#PP">PP</a> -macro. -</p> - -<p> -At the end of the letter, should you wish an indented closing -("Yours truly," "Sincerely," "Hugs and -kisses"), invoke the macro, <kbd>.CLOSING</kbd>, on a -line by itself and follow it with the text of the closing. -<strong>N.B.</strong> Don't put your name here; <strong>mom</strong> -supplies it automatically from <strong>AUTHOR</strong> with -enough space to leave room for your signature. -</p> - -<p> -Assuming our tutorial letter is for business correspondence, -here's what the complete letter looks like. -</p> - -<pre> - .AUTHOR "Yannick P. Guique" - .DOCTYPE LETTER - .PRINTSTYLE TYPESET - .START - .DATE - August 25, 2004 - .TO - GUILLAUME BARRIÈRES - Minidoux Corporation - 5000 Pannes Drive - Redmond, Virginia - .FROM - Y.P. GUIQUE - 022 Umask Road - St-Sauveur-en-dehors-de-la-mappe, Québec - .GREETING - Dear Mr. Barrières, - .PP - It has come to my attention that you have been lobbying the - US government to prohibit the use of open source software by - endeavouring to outlaw so-called "warranty free" - applications. - .PP - I feel it is my duty to inform you that the success of your - operating system with its embedded web browser relies heavily - on open source programs and protocols, most notably TCP/IP. - .PP - Therefore, in the interests of your corporation's fiscal health, - I strongly advise that you withdraw support for any US - legislation that would cripple or render illegal open source - development. - .CLOSING - Sincerely, -</pre> - -<p> -This produces a letter with headers that follow the North American -standard for business correspondence. If you'd prefer another style -of correspondence, for example, British, you'd set up the same -letter like this: - -<pre> - .AUTHOR "Yannick P. Guique" - .DOCTYPE LETTER - .PRINTSTYLE TYPESET - .START - .FROM - .RIGHT - Y.P. GUIQUE - 022 Umask Road - St-Sauveur-en-dehors-de-la-mappe, Québec - .TO - GUILLAUME BARRIÈRES - Minidoux Corporation - 5000 Pannes Drive - Redmond, Virginia - .DATE - .RIGHT - August 25, 2004 - .GREETING - Dear Mr. Barrières, -</pre> -</p> - -<p> -Notice the use of <kbd>.RIGHT</kbd> after <kbd>.FROM</kbd> and -<kbd>.DATE</kbd> in this example, used to change the default quad -for these macros. -</p> - -<hr width="66%" align="left"/> - -<a name="LETTERS_DEFAULTS"><h2><u>Defaults for letters</u></h2></a> - -<p> -In letters, if the order of header macros is - -<pre> - .DATE - .TO - .FROM - .GREETING -</pre> - -<strong>mom</strong> sets - -<ol> - <li>the date flush right, page right, at the top of page one, - with a gap of two linespaces underneath - </li> - <li>the addressee in a block flush left, page left, with a gap of - one linespace underneath - </li> - <li>the addresser in a block flush left, page left, with a gap of - one linespace underneath - </li> - <li>the greeting flush left, with a gap of one linespace - underneath - </li> -</ol> -</p> - -<p> -which is the standard for North American business correspondence. -</p> - -<p> -If you switch the order of <kbd>.DATE</kbd>, <kbd>.TO</kbd> and/or -<kbd>.FROM</kbd>, <strong>mom</strong> sets all the headers -flush left, with a gap of one linespace underneath each. (The -default left quad of any header can be changed by invoking the -<kbd>.RIGHT</kbd> macro, on a line by itself, immediately before -inputting the text of the header.) -</p> - -<p> -Following the headers, <strong>mom</strong> sets - -<ul> - <li>the body of the letter justified</li> - <li>in multi-page letters:</li> - <ul> - <li>a footer indicating there's a next page (of the form <nobr><kbd>.../#</kbd>)</nobr></li> - <li>the page number at the top of every page after page one</li> - </ul> - <li>the closing/signature line flush left, indented halfway across the page</li> -</ul> -</p> - -<p> -Other important style defaults are listed below, and may be changed -via the -<a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a> -or the document processing -<a href="definitions.html#TERMS_CONTROLMACRO">control macros</a> -prior to -<a href="docprocessing.html#START">START</a>. Assume that any -style parameter not listed below is the same as for -<a href="docprocessing.html#TYPESET_DEFAULTS">PRINTSTYLE TYPESET</a> -or -<a href="docprocessing.html#TYPEWRITE_DEFAULTS">PRINTSTYLE TYPEWRITE</a>. -</p> - -<pre> -PARAMETER PRINTSTYLE TYPESET PRINTSTYLE TYPEWRITE ---------- ------------------ -------------------- - -Paper size 8.5 x 11 inches 8.5 x 11 inches -Left/right margins 1.125 inches 1.125 inches -Header margin 3.5 picas 3.5 picas - (for page numbers) -Header gap 3 picas 3 picas - (for page numbers) -Family Times Roman Courier -Font roman roman -Point size 12 12 -Line space 13.5 12 (i.e. singlespaced) -Paragraph indent 3 ems 3 picas -Spaced paragraphs yes no -Footers* yes yes -Footer margin 3 picas 3 picas -Footer gap 3 picas 3 picas -Page numbers top, centred top, centred - -*Footers contain a "next page" number of the form .../# -</pre> - -<hr/> - -<a name="LETTERS_MACROS"><h2><u>The letter macros</u></h2></a> - -<p> -All letter macros must come after -<a href="docprocessing.html#START">START</a>, -except <strong>NO_SUITE</strong>. -</p> - -<ul> - <li><a href="#DATE">DATE</a></li> - <li><a href="#TO">TO</a></li> - <li><a href="#FROM">FROM</a></li> - <li><a href="#GREETING">GREETING</a></li> - <li><a href="#CLOSING">CLOSING</a></li> - <li><a href="#NO_SUITE">NO_SUITE</a> — "next page" number off</li> -</ul> - -<!-- -DATE- --> - -<hr width="66%" align="left"/> - -<a name="DATE"></a> - -<p> -Macro: <strong>DATE</strong> -</p> - -<p> -Invoke <kbd>.DATE</kbd> on a line by itself, with the date -underneath, like this: - -<pre> - .DATE - October 31, 2002 -</pre> -</p> - -<p> -If you wish to change the default quad direction for the date, -enter <kbd>.LEFT</kbd> or <kbd>.RIGHT</kbd>, on a line by itself, -immediately after <kbd>.DATE</kbd>. -</p> - -<p> -If you wish to insert additional space between the date and any -letter header that comes after it, do so after inputting the date, -not at the top of the next header macro, like this: - -<pre> - .DATE - October 31, 2002 - .SPACE \"Or, more simply, .SP -</pre> -</p> - -<p> -If you wish to remove the default space, - -<pre> - .SPACE -1v \"Or, more simply, .SP -1v -</pre> - -will do the trick. -</p> - -<!-- -TO- --> - -<hr width="33%" align="left"/> - -<a name="TO"></a> - -<p> -Macro: <strong>TO</strong> -</p> - -<p> -Invoke <kbd>.TO</kbd> on a line by itself, with the name -and address of the addressee underneath, like this: - -<pre> - .TO - JOHN SMITH - 10 Roberts Crescent - Bramladesh, Ont. -</pre> -</p> - -<p> -If you wish to change the default quad direction for the address, -enter <kbd>.LEFT</kbd> or <kbd>.RIGHT</kbd>, on a line by itself, -immediately after <kbd>.TO</kbd>. -</p> - -<p> -If you wish to insert additional space between the address and -any letter header that comes after it, do so after inputting the -address, not at the top of the next header macro, like this: - -<pre> - .TO - JOHN SMITH - 10 Roberts Crescent - Bramladesh, Ont. - .SPACE \"Or, more simply, .SP -</pre> -</p> - -<p> -If you wish to remove the default space, - -<pre> - .SPACE -1v \"Or, more simply, .SP -1v -</pre> - -will do the trick. -</p> - -<!-- -FROM- --> - -<hr width="33%" align="left"/> - -<a name="FROM"></a> - -<p> -Macro: <strong>FROM</strong> -</p> - -<p> -Invoke <kbd>.FROM</kbd> on a line by itself, with the name -and address of the addresser underneath, like this: - -<pre> - .FROM - JOE BLOW - 15 Brunette Road - Ste-Vieille-Andouille, Québec -</pre> -</p> - -<p> -If you wish to change the default quad direction for the address, -enter <kbd>.LEFT</kbd> or <kbd>.RIGHT</kbd>, on a line by itself, -immediately after <kbd>.FROM</kbd>. -</p> - -<p> -If you wish to insert additional space between the address and -any letter header that comes after it, do so after inputting the -address, not at the top of the next header macro, like this: - -<pre> - .FROM - JOE BLOW - 15 Brunette Road - Ste-Vieille-Andouille, Québec - .SPACE \"Or, more simply, .SP -</pre> -</p> - -<p> -If you wish to remove the default space, - -<pre> - .SPACE -1v \"Or, more simply, .SP -1v -</pre> - -will do the trick. -</p> - -<!-- -GREETING- --> - -<hr width="33%" align="left"/> - -<a name="GREETING"></a> - -<p> -Macro: <strong>GREETING</strong> -</p> - -<p> -Invoke <kbd>.GREETING</kbd> on a line by itself, with the -full salutation you want for the letter, like this: - -<pre> - .GREETING - Dear Mr. Smith, -</pre> -</p> - -<!-- -CLOSING- --> - -<hr width="33%" align="left"/> - -<a name="CLOSING"></a> - -<p> -Macro: <strong>CLOSING</strong> -</p> - -<p> -Invoke <kbd>.CLOSING</kbd> on a line by itself after the body of the -letter, with the closing you'd like (e.g. "Yours truly,"), -like this: - -<pre> - .CLOSING - Yours truly, -</pre> -</p> - -<p> -There are two macros that may be used to control the behaviour -of <kbd>.CLOSING</kbd>: <strong>CLOSING_INDENT</strong> and -<strong>SIGNATURE_SPACE</strong>. -</p> - -<a name="CLOSING_INDENT"></a> -<p> -The first, <strong>CLOSING_INDENT</strong>, indicates the distance -from the left margin you'd like to have your closing indented. It -takes a single -<a href="definitions.html#TERMS_NUMERICARGUMENT">numeric argument</a> -and must have a -<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> -appended to it, unless you want an indent of 0 (zero). -<strong>Mom</strong>'s default is 1/2 the width of the letter's line -length (i.e. halfway across the page). If you wanted instead an -indent of 6 -<a href="definitions.html#TERMS_PICASPOINTS">picas</a>, -you'd do it like this: - -<pre> - .CLOSING_INDENT 6P -</pre> - -Or, if you wanted to have no indent at all: - -<pre> - .CLOSING_INDENT 0 -</pre> -</p> - -<a name="SIGNATURE_SPACE"></a> -<p> -The second, <strong>SIGNATURE_SPACE</strong>, controls how much room -to leave for the signature. It takes a single -<a href="definitions.html#TERMS_NUMERICARGUMENT">numeric argument</a> -and must have a -<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> -appended to it. <strong>Mom</strong>'s default is 3 line spaces, -but if you wanted to change that to, say, 2 line spaces, you'd do: - -<pre> - .SIGNATURE_SPACE 2v -</pre> -</p> - -<!-- -NO_SUITE- --> - -<hr width="33%" align="left"/> - -<a name="NO_SUITE"></a> - -<p> -Macro: <strong>NO_SUITE</strong> -</p> - -<p> -If you don't want <strong>mom</strong> to print a "next -page" number at the bottom of multi-page letters, invoke -<kbd>.NO_SUITE</kbd>, on a line by itself, prior to -<a href="docprocessing.html#START">START</a>. -</p> - -<hr/> - -<p> -<a href="macrolist.html#TOP">Next</a> -<a href="refer.html#TOP">Prev</a> -<a href="#TOP">Top</a> -<a href="toc.html">Back to Table of Contents</a> -</p> - -</body> -</html> - -<!-- vim: fileencoding=latin1: nomodified: ---> |