Return to lexicon CVS log

Up to [MW Coherent from dump] / coherent / a / usr / man / ALL

Annotation of coherent/a/usr/man/ALL/lexicon, revision 1.1.1.1

1.1       root        1: 
                      2: 
                      3: Lexicon                    Introduction                   Lexicon
                      4: 
                      5: 
                      6: 
                      7: 
                      8: The Mark  Williams Lexicon is a new  approach to documentation of
                      9: computer software.  The Lexicon is designed to improve documenta-
                     10: tion and  eliminate some  limitations found in  more conventional
                     11: documentation.
                     12: 
                     13: ***** How to Use the Lexicon *****
                     14: 
                     15: The Lexicon consists  of one large document that contains entries
                     16: for  every  aspect of  COHERENT.   You will  not  have to  search
                     17: through a  number of different manuals to find  the entry you are
                     18: looking for.
                     19: 
                     20: Every entry  in the  Lexicon has  the same structure.   The first
                     21: line gives the name of the topic being discussed, followed by its
                     22: type (e.g., CCoommmmaanndd).
                     23: 
                     24: The next  lines briefly describe  the item, then  give the item's
                     25: usage, where  applicable.  These are followed  by a brief discus-
                     26: sion of the item, and an example.
                     27: 
                     28: Cross-references  follow.  These  can be to  other entries  or to
                     29: other texts.   Diagnostics and notes,  where applicable, conclude
                     30: each entry.
                     31: 
                     32: Internally, the Lexicon has a tree structure.  The ``root'' entry
                     33: is the  present entry, for  LLeexxiiccoonn.  Below this  entry comes the
                     34: set of _O_v_e_r_v_i_e_w  entries.  Each Overview entry introduces a group
                     35: of entries; for example, the Overview entry for ssttrriinngg introduces
                     36: all of  the string functions and macros, lists  them, and gives a
                     37: lengthy example of how to use them.
                     38: 
                     39: Each entry cross-references  other entries.  These cross-referen-
                     40: ces point  up the documentation tree,  toward an overview article
                     41: and,  ultimately, to  the entry  for  Lexicon itself.   They also
                     42: point down the tree to subordinate entries, and across to entries
                     43: on related  subjects.  For example, the  entry for ggeettcchhaarr cross-
                     44: references SSTTDDIIOO, which is its Overview article, plus ppuuttcchhaarr and
                     45: ggeettcc, which  are related  entries of  interest to the  user.  The
                     46: Lexicon is designed  so that you can trace from  any one entry to
                     47: any other,  simply by following the  chain of cross-references up
                     48: and down the documentation tree.
                     49: 
                     50: See the  logic tree  that is included  in the appendices  to this
                     51: manual for the full tree structure of the Lexicon.
                     52: 
                     53: ***** Use the Lexicon *****
                     54: 
                     55: If, while  reading an entry, you encounter  a technical term that
                     56: you do  not understand,  look it up  in the Lexicon.   You should
                     57: find an  entry for  it.  For  example, if a  function is  said to
                     58: return a data type float and you do not know exactly what a float
                     59: is, look  it up.  You  will find it  described in full.   In this
                     60: way, you should increase your understanding of COHERENT, and make
                     61: your programming easier and more productive.
                     62: 
                     63: 
                     64: COHERENT Lexicon                                           Page 1
                     65: 
                     66: 
                     67: 
                     68: 
                     69: Lexicon                    Introduction                   Lexicon
                     70: 
                     71: 
                     72: 
                     73: 
                     74: ***** Overview Articles *****
                     75: 
                     76: The Lexicon  includes the  following overview articles.   Look at
                     77: the appropriate  overview article for information  on the subject
                     78: in which you are  interested.  The overview article will give you
                     79: an overview of the topic, and tell you which Lexicon articles you
                     80: should read to find detailed information.
                     81: 
                     82: 
                     83:      C language
                     84:      commands
                     85:      definitions
                     86:      device drivers
                     87:      environmental variables
                     88:      file formats
                     89:      system maintenance
                     90:      technical information
                     91: 
                     92: 
                     93: 
                     94: 
                     95: 
                     96: 
                     97: 
                     98: 
                     99: 
                    100: 
                    101: 
                    102: 
                    103: 
                    104: 
                    105: 
                    106: 
                    107: 
                    108: 
                    109: 
                    110: 
                    111: 
                    112: 
                    113: 
                    114: 
                    115: 
                    116: 
                    117: 
                    118: 
                    119: 
                    120: 
                    121: 
                    122: 
                    123: 
                    124: 
                    125: 
                    126: 
                    127: 
                    128: 
                    129: 
                    130: COHERENT Lexicon                                           Page 2
                    131: 
                    132: 

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.