layout/doc/index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4   <title>Layout Documentation Index Page</title>
   5
   6   <meta http-equiv="content-type"
   7  content="text/html; charset=ISO-8859-1">
   8
   9  <style>
  10  /* colors for status of documents */
  11    *.ood        { color: red !important; }
  12    *.good       { color: black !important; }
  13    *.wip        { color: blue !important; }
  14    *.unassigned { color: green !important; }
  15  /* inherit the colors into the links */
  16   p > a         { color: inherit; }
  17   </style>
  18 </head>
  19 <body>
  20
  21 <h1>Layout Technical Documentation: Primary Index</h1>
  22 <p class="wip">Document Status: Work In Progress (attinasi)
  23 <p>The goal of this document is to provide extensive links to documentation
  24 on the Gecko Layout components and classes. There are two sections containing
  25 links to the documents, and there is overlap between these sections by
  26 design.   First, there is a '<a href="#TopicIndex">Topics</a>' section,
  27 where  documentation   is listed by generic topics, more or less free-form
  28 and ad-hoc.  Second, there  is a '<a href="#ClasscomponentIndex">Class and
  29 Component</a>'  section, where  specific classes and components are listed,
  30 mapping naturally  to the source  code. All documents should be indexed in
  31 both sections, so  pick the index  that corresponds to what you are thinking
  32 about. A <a href="#HowTo">Tech Notes section</a> is also included to help
  33 contributors   find information on small topics and issues, including simple
  34 'How To' cookbooks.
  35
  36 <p><blockquote>
  37 <i>For information about the structure of layout documents, see the <a
  38  href="http://lxr.mozilla.org/seamonkey/source/layout/doc/overview.html">Layout
  39     Documentation Overview</a>&nbsp; and the Layout DocumentationTemplates
  40  (<a
  41  href="http://lxr.mozilla.org/seamonkey/source/layout/doc/hld-template.html">High
  42     Level Design Template</a> / <a
  43  href="http://lxr.mozilla.org/seamonkey/source/layout/doc/dd-template.html">Detailed
  44     Design Template</a>).
  45 </i>
  46 </blockquote>
  47
  48 <hr width="100%" size="2">
  49
  50 <div align="left"
  51  style="border: 1px solid blue; margin: auto; width: 65%;"><big><b>Legend</b></big>
  52 <ul>
  53     <li class="good">Black: complete and believed to be up to date (class='good')</li>
  54     <li class="wip">Blue: incomplete or work in progress (class='wip')</li>
  55     <li class="ood">Red: out of date or innacurate (class='ood', bug should be filed and bug number / link noted)</li>
  56     <li class="unassigned">Green: unassigned work</li>
  57    </li>
  58 </ul>
  59 </div>
  60
  61 <h2><a name="TopicIndex"></a>Topic Indices</h2>
  62
  63 <div style="border: 1px solid black; margin: 1em; padding: 1em;">
  64  <p class="wip">What is Layout? The High Level Layout Overview (attinasi)
  65  <p class="wip">Debugging Layout (bernd)
  66  <p class="unassigned">How Reflow works
  67  <p class="wip">Tables balancing (karnaze)
  68  <p class="wip">Table Borders collapsing (karnaze)
  69  <p class="wip">Block in Inline situations (kin)
  70  <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/HLD-SpaceManager.html">Managing  Floats</a>
  71  <p class="unassigned">Text Measurement and Text Breaking
  72  <p class="unassigned">Image loading and display
  73  <p class="unassigned">Margin Collapsing
  74  <p class="unassigned">Scrolling Blocks
  75  <p class="unassigned">Box and Block interactions
  76  <p class="wip">Printing and Print Preview (rods)
  77  <p class="unassigned">Plugins: the object frame and related layout classes
  78 </div>
  79
  80 <h2><a name="ClasscomponentIndex"></a>Class and Component Indices</h2>
  81
  82 <div style="border: 1px solid black; margin: 1em; padding: 1em;">
  83  <p class="unassigned">Presentation Shell and Context: High Level / Detailed
  84  <p class="unassigned">Frames and the Frame Manager: High Level / Detailed
  85  <p class="good">Reflow: <a href="http://www.mozilla.org/newlayout/doc/reflow.html">High Level (waterson)</a> / <span class="unassigned">Detailed</span>
  86  <p class="unassigned">Block and Line layout: High Level / Detailed
  87  <p class="unassigned">TextFrame - Text Measurement and Line Breaking: High Level / Detailed
  88  <p class="wip">PageSequenceFrame and PageFrame: High Level / Detailed (rods)
  89  <p class="unassigned">Object Frame: High Level / Detailed
  90  <p class="good">Space Manager:
  91    <a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/HLD-SpaceManager.html">High Level</a> /
  92    <a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/DD-SpaceManager.html">Detailed</a>
  93  <p class="wip">Layout Debug Plugin: high Level / Detailed (dcone)
  94 </div>
  95
  96 <h2><a name="HowTo"></a>How To / Tech Notes</h2>
  97
  98 <div style="border: 1px solid black; margin: 1em; padding: 1em;">
  99  <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/frame_reflow_debug.html">How to Debug Reflow </a>
 100  <p class="good"><a href="http://www.mozilla.org/newlayout/doc/block-and-line.html">Waterson's Block and Line Cheat Sheet</a>
 101  <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/adding-style-props.html">How to add Style Properties</a>
 102  <p class="unassigned">Measuring Layout Performance
 103  <p class="wip"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/regression_tests.html">Running the Regression Tests (bernd/dcone)</a>
 104  <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/debugtable.html">Debugging Table Reflow</a>
 105 </div>
 106
 107 <hr width="100%" size="2">
 108  <p>Authors:
 109   <ul>
 110     <li>Marc Attinasi (attinasi@netscape.com)</li>
 111   </ul>
 112   <p>Document History:
 113   <ul>
 114    <li>05/06/2002 - Marc Attinasi: created</li>
 115    <li>05/13/2002 - Marc Attinasi: added Block and Line Cheat Sheet, and link to existing Reflow document</li>
 116    <li>05/21/2002 - Marc Attinasi: added Bernd's Table Reflow Debugging How-To (thanks Bernd!)</li>
 117    <li>05/21/2002 - Bernd Mielke: added Frame  Reflow Debugging How-To</li>
 118    <li>06/16/2002 - Bernd Mielke: added layout regression test description</li>
 119   </ul>
 120
 121 </body>
 122 </html>