cgit.sxemacs.org Git - packages/blob - xemacs-packages/cogre/cogre.texi

   1 \input texinfo   @c -*-texinfo-*-
   2 @c
   3 @c $Id: cogre.texi,v 1.1 2007-11-26 15:04:24 michaels Exp $
   4 @c
   5 @setfilename cogre.info
   6 @settitle COGRE: COnnected GRaph Editor
   7
   8 @ifinfo
   9 @format
  10 START-INFO-DIR-ENTRY
  11 * cogre: (cogre).       Graphs & UML for Emacs
  12 END-INFO-DIR-ENTRY
  13 @end format
  14 @end ifinfo
  15
  16 @titlepage
  17 @sp 10
  18 @center @titlefont{cogre}
  19 @vskip 0pt plus 1 fill
  20 Copyright @copyright{} 2001 Eric M. Ludlam
  21 @end titlepage
  22
  23
  24 @node Top, , , (dir)Top
  25 @comment  node-name,  next,  previous,  up
  26
  27 COGRE is a package that enables Emacs to display UML diagrams in a
  28 text buffer.  Any kind of graph can be supported through object
  29 inheritance via EIEIO @xref{(eieio)Top}.
  30
  31 Warning: Very little in this manual has been written.
  32
  33 @menu
  34 * Getting Started::       Graphs, Nodes, and Links
  35 * Class Diagrams::        Creating Class diagrams
  36 * Semantic Support::      Emacs can make diagrams for you
  37 * Index::
  38 @end menu
  39
  40 @node Getting Started, Class Diagrams, Top, Top
  41 @comment  node-name,  next,  previous,  up
  42 @chapter Getting Started
  43
  44 There are three basic parts to any COGRE interface.
  45
  46 @enumerate
  47 @item Graph
  48 The graph consists of a buffer, and all child elements in that graph.
  49 The graph is treated as any other Emacs buffer.  When that buffer is
  50 selected, Graph editing commands are available.
  51 @item Node
  52 A Node consists of a square region of screen space, and usually a
  53 name.  Nodes can be anything, but common examples are Classes,
  54 Packages, or other ``object like'' things.
  55 @item Link
  56 A Link is a line that connects two nodes.  A link may not exist
  57 without a node at both ends.  When a node is deleted, all links
  58 connected to it in some way are also deleted.
  59 @end enumerate
  60
  61 @menu
  62 * Creating Nodes and Links ::
  63 * Moving Nodes ::
  64 * Customizing Nodes ::
  65 @end menu
  66
  67 @node Creating Nodes and Links, Moving Nodes, Getting Started, Getting Started
  68 @comment  node-name,  next,  previous,  up
  69
  70 @node Moving Nodes, Customizing Nodes, Creating Nodes and Links, Getting Started
  71 @comment  node-name,  next,  previous,  up
  72
  73 @node Customizing Nodes, , Moving Nodes, Getting Started
  74 @comment  node-name,  next,  previous,  up
  75
  76 @node Class Diagrams, Semantic Support, Getting Started, Top
  77 @comment  node-name,  next,  previous,  up
  78 @chapter Class Diagrams
  79
  80 Add text here
  81
  82 @node Semantic Support, Index ,Class Diagrams, Top
  83 @comment  node-name,  next,  previous,  up
  84 @chapter Semantic Support
  85
  86 Add text here
  87
  88 @node Index, , Semantic Support, Top
  89 @comment  node-name,  next,  previous,  up
  90
  91 @contents
  92
  93 @bye