From owner-freebsd-doc Tue Jan 7 14:46:59 1997 Return-Path: Received: (from root@localhost) by freefall.freebsd.org (8.8.4/8.8.4) id OAA17067 for doc-outgoing; Tue, 7 Jan 1997 14:46:59 -0800 (PST) Received: from gatekeeper.fsl.noaa.gov (gatekeeper.fsl.noaa.gov [137.75.131.181]) by freefall.freebsd.org (8.8.4/8.8.4) with ESMTP id OAA17059 for ; Tue, 7 Jan 1997 14:46:57 -0800 (PST) Received: from cardinal.fsl.noaa.gov (daemon@cardinal.fsl.noaa.gov [137.75.60.101]) by gatekeeper.fsl.noaa.gov (8.7.5/8.7.3) with ESMTP id WAA07885; Tue, 7 Jan 1997 22:46:53 GMT Received: from auk.fsl.noaa.gov by cardinal.fsl.noaa.gov with SMTP (1.40.112.3/16.2) id AA061517213; Tue, 7 Jan 1997 22:46:53 GMT Message-Id: <32D2D2C5.700C@fsl.noaa.gov> Date: Tue, 07 Jan 1997 15:48:37 -0700 From: Sean Kelly Organization: CIRA/NOAA X-Mailer: Mozilla 3.0Gold (X11; I; HP-UX B.10.10 9000/725) Mime-Version: 1.0 To: John Fieber Cc: doc@FreeBSD.ORG Subject: Re: Typographic conventions References: Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Sender: owner-doc@FreeBSD.ORG X-Loop: FreeBSD.org Precedence: bulk John Fieber wrote: > Cast your votes now! As a general rule, I prefer to see as little variation in typography as possible; some computer books out there have so many different conventions for so many different things that a page appears as something not too unlike dog vomit. > Abbrev- Abbreviation, especially one followed by a period Chicago probably says small caps ... I say normal body all caps. > Acronym- Pronounceable contraction of initials Body caps, no periods. > Application- Name of a software program Initial word capitalization, body copy font. > ClassName- Name of the class to which a program component belongs Lower case body copy. > Command- Executable program, or the entry a user makes to execute a command Urg. Good question. > ComputerOutput- Data presented to the user by a computer Fixed width font. > Database- Name of an organized set of data Huh? I guess I should check the web address. > Email- Email address in an Address Body copy font. > Emphasis- Emphasized text Bold. Italic emphasis is nice, but often too light. > ErrorName- Error message reported by a computer Treat like ComputerOutput. > ErrorType- Classification of an error message reported by a computer Body copy font. > Filename- Name of a file, possibly including pathname Body copy font. > FirstTerm- First occurrence of a word in a given context Italic? > ForeignPhrase- Word or words in a language other than that of the containing document Chicago probably says italic. There are so many foreign words in English now that we can probably do without. Body copy font. > Function- Subroutine in a program or external library Body copy font. > GUIButton- Text on a button in a graphical user interface Body copy font, but with capitalization verbatim from the UI. > GUIIcon- Graphic and, or, text appearing as a icon in a graphical user interface Tufte would recommend using a copy of the icon itself as any other glyph. I agree. > GUILabel- Text in a graphical user interface > GUIMenu- Name of a menu in a graphical user interface > GUIMenuItem- Name of a terminal menu item in a graphical user interfac > GUISubmenu- Name of a submenu in a graphical user interface As with GUIButton. > GlossTerm- Term outside a Glossary that is defined in some GlossEntry Italic. > Hardware- Physical part of a computer system Body copy font. > Interface- Element of a graphical user interface Body copy font. > InterfaceDefinition- Specification for a graphical user interface Huh? > KeyCap- Text printed on a physical key on a computer keyboard, not > necessarily the same thing as a KeyCode Small caps? > KeyCode- Computer's numeric designation of a key on a computer keyboard Body copy font. > KeyCombo- Combination of input actions Small caps? > KeySym- Key symbol name, which is not necessarily the same thing as a Keycap Body copy font. > MediaLabel- Name of the physical medium on or in which some information > is contained Body copy font. > MenuChoice- Menu selection or series of such selections Body copy font. > MouseButton- Conventional name of a mouse button Body copy font. > MsgText- Contents of the parts of Msg Body copy font. > Option- Option for a computer program command Body copy font. > Optional- Optional information contained in a Synopsis Body copy font. > Parameter- Part of an instruction to a computer What's the difference here with Replaceable? Maybe italics, maybe body copy font. > Property- Defined set of data associated with a window Body copy font. > Replaceable- Content that may be replaced in a synopsis or command line Italics. > ReturnValue- Value returned by a function > StructField- Field in a Structure > StructName- Name of a Structure > Symbol- Name that is replaced by a value before processing > SystemItem- System-related term or item > Token- Unit of information in the context of lexical analysis > Type- Classification of a value Body copy font. > UserInput- Data entered by the user Bold fixed width. -- Sean Kelly NOAA Forecast Systems Laboratory kelly@fsl.noaa.gov Boulder Colorado USA http://www-sdd.fsl.noaa.gov/~kelly/