\begindata{text,268990956}
\textdsversion{12}
\template{help}
\chapter{Writing and Editing Texts on Athena}


To produce a printed text document using a computer, you use programs that 
perform two different functions.  Text \bold{\italic{editing}} programs help 
you with the "mechanics" of creating and editing text, and display documents 
for you on the computer screen.   Text \bold{\italic{formatting}} programs 
"translate" documents into a form that a printer understands, so that they are 
properly spaced on the page and include the formatting effects (such as 
boldface text) that you have specified.   The Athena system offers you a 
choice of several programs for both kinds of functions.   One solution, EZ, 
serves both as an editor and a formatter.


\section{Text editing programs 

}
Most people who use Athena system workstations write and edit their text 
documents with the editor called \bold{EZ}, which was specifically designed 
for use on Athena workstations.  It takes full advantage of many Athena 
features, including scrollbars, menus and multiple windows.  It produces 
documents that are stored in the special \bold{A}ndrew \bold{T}ool\bold{K}it 
datastream format (ATK format for short. Sometimes in old documents refered to 
as BE2 format).  


You may be familiar with one of the other commonly used editors (\bold{Emacs}, 
\bold{vi}, \bold{ed }and \bold{ex}) from working with them on a personal 
computer or terminal.  They do not employ the same Andrew features as EZ, and 
produce files in regular ASCII storage format.


The available text editing programs:

  

\leftindent{\bold{EZ} allows you to edit not only text, but also information 
in several different forms (or "media"), including line drawings, tables and 
spreadsheets, rasters, equations and even animations.  You can also inset 
information in the different media into text to create "multi-media" 
documents.   For details, see the  \italic{ez } and  \italic{insets } help 
documents.  Other help documents related to EZ are listed at the end of this 
document in the \bold{Related Tools} section.  For an introduction to the 
editors you use to edit non-text media see the  \italic{insets} Andrew help 
document.  Also, if you are editing large documents, you should check out the 
\italic{datapros} program which enables composing large documents from smaller 
ez files.


\bold{Emacs}, officially supported for all Athena users.  For an overview of 
this versatile text editor and a listing of available help information, see 
the  \italic{emacs } help document.  EZ supports almost all the keybindings 
used by emacs to perform editing operations (thus making the two editors 
compatible).


\bold{vi}, a UNIX text editor.  Like EZ and Emacs, it displays your document 
in a window on the screen.  For more information about vi, see the  \italic{vi 
} help document for a brief explanation, or consult a hardcopy UNIX system 
manual.  


\bold{ed} and \bold{ex}, older UNIX line editing programs. This means that you 
can see and manipulate only one line of your document at a time.  For more 
information, see the help documents for  \italic{ed  }and  \italic{ex } or 
consult a UNIX system manual.

}
\section{Text formatting programs}


One major difference between EZ and the other editors is that EZ shows you on 
the screen the effect of applying different formatting styles (boldface, 
centering and so on) to text.  You choose from menu options to apply many of 
the styles, but you can also achieve formatting effects that are not available 
as menu options (see the sections on styles in the  \italic{ez}  help 
document).  These formatting effects, as well as the ones you can see on your 
screen, show up in printed output.  You do not need to process EZ documents 
with a text formatting program before printing, because the processing is done 
automatically when you choose \bold{Print }as a menu option or use the 
\typewriter{ezprint} command from your command prompt.  See the section on 
Printing in the \italic{ ez } help document, the \italic{ ezprint}  document 
or the  \italic{Printing}  overview document for details.


With the other four text editing programs listed above, formatting effects 
show up in printed output only.  You indicate the desired styles by including 
commands from one of the two available formatting programs (\bold{Scribe} and 
\bold{troff}) in the text of the document.  You then process the document with 
the formatting program and submit the processed output for printing.  See the 
 \italic{Printing} overview document and  \italic{print}  help document for 
information about printing.


The available text formatting programs:


\leftindent{\bold{Scribe} is a text formatting program widely used in 
conjunction with Emacs (but it can be used with any text editor).  Scribe, 
developed by  Brian K. Reid of Carnegie Mellon University, has been fully 
supported, with training, documentation and consulting available, since the 
inception of Athena.  A large portion of the user community, including Athena 
itself, has documents which rely on Scribe.  Due to concerns about Scribe's 
future availability from the vendor, especially on new hardware platforms, 
Athena is re-evaluating formatting needs and support policies.  Independent of 
that re-evaluation, Scribe will continue to be available on the current 
hardware platforms.  See the  \italic{scribe } help document for information 
about preparing and printing Scribe files on Athena. } 


\leftindent{\bold{troff} and \bold{nroff} are UNIX-based formatting packages 
that both produce output capable of driving a printer.   Troff is used to 
format documents for laser printing (all public Athena printers are laser 
printers), while Nroff is used to format documents for display on terminals or 
for printing on line printers.  These packages share many formatting commands, 
but they can be difficult to use.  You can find some information about these 
packages in the  \italic{nroff } and  \italic{troff}  help documents, but the 
best sources are in the hardcopy UNIX system manuals.  A listing of troff 
commands that can be used in EZ documents is available in the 
 \italic{ez-troff } help document. }


\leftindent{\bold{Preview } is an Andrew program that allows you to see on 
your screen what your printed EZ document will look like, before you actually 
print it.  This is useful because it can help you catch and correct mistakes 
before you take the time to print.  Also, even though EZ shows you on the 
screen the styles you have applied, the screen version of a document can 
differ from the printed version in several ways.  For one thing, you cannot 
tell on the screen where the lines will end, because windows can vary in 
width.  The screen is also more limited than a printer in the type sizes it 
can display.


Preview works for all files which contain EZ styles and troff commands.  When 
you use Preview, you must make corrections by editing the document again with 
EZ.  See the  \italic{preview}  help document for more details.

}
\section{Rules for naming your documents}

\leftindent{
You must give a unique name to every file or document that you edit on Athena. 
 You can name files anything you like, but the following suggestions will help 
you avoid potential problems.


1. If you include capital letters in a filename, you must use them every time 
you type the filename.  The UNIX command interpreter that processes your 
keyboard commands distinguishes between upper case and lower case letters. 
 The following are all acceptable document names:


\leftindent{ToDo   physics.report.1  Englishnotes  termpaper.mss}


2. The following characters have special meaning to UNIX.  While it is 
possible to use them in a filename, it is better not to do so, just to avoid 
having your commands misinterpreted:


\leftindent{/  \\  "  '  *  ;  -  ?  [  ]  \{  \}  (  )  ~  !  $  <  >   space}


3. The ez editor/formatter assigns special meaning to filenames ending in 
certain extensions, for example: .help, .txt, .ez, .eq and .doc.  For 
information on these extensions, view the Andrew help file 
\italic{ez-extensions}.

}
\section{Related Tools}

\leftindent{
Select (put a box around) one of the italicized names and choose "Get Help on 
Selected Word" to see the help document for:


\leftindent{\italic{Andrew }

\italic{Printing}

\italic{ez

ez-extensions

ez-troff

datapros

emacs

ed

ex

vi

insets

preview

scribe

nroff

troff

}}}\enddata{text,268990956}
