diff options
Diffstat (limited to 'layout/doc/index.html')
| -rw-r--r-- | layout/doc/index.html | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/layout/doc/index.html b/layout/doc/index.html new file mode 100644 index 000000000..c5c4bc2c9 --- /dev/null +++ b/layout/doc/index.html @@ -0,0 +1,126 @@ +<!-- This Source Code Form is subject to the terms of the Mozilla Public + - License, v. 2.0. If a copy of the MPL was not distributed with this + - file, You can obtain one at http://mozilla.org/MPL/2.0/. --> + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <title>Layout Documentation Index Page</title> + + <meta http-equiv="content-type" + content="text/html; charset=ISO-8859-1"> + + <style> + /* colors for status of documents */ + *.ood { color: red !important; } + *.good { color: black !important; } + *.wip { color: blue !important; } + *.unassigned { color: green !important; } + /* inherit the colors into the links */ + p > a { color: inherit; } + </style> +</head> +<body> + +<h1>Layout Technical Documentation: Primary Index</h1> +<p class="wip">Document Status: Work In Progress (attinasi) +<p>The goal of this document is to provide extensive links to documentation +on the Gecko Layout components and classes. There are two sections containing +links to the documents, and there is overlap between these sections by +design. First, there is a '<a href="#TopicIndex">Topics</a>' section, +where documentation is listed by generic topics, more or less free-form +and ad-hoc. Second, there is a '<a href="#ClasscomponentIndex">Class and +Component</a>' section, where specific classes and components are listed, +mapping naturally to the source code. All documents should be indexed in +both sections, so pick the index that corresponds to what you are thinking +about. A <a href="#HowTo">Tech Notes section</a> is also included to help +contributors find information on small topics and issues, including simple +'How To' cookbooks. + +<p><blockquote> +<i>For information about the structure of layout documents, see the <a + href="http://lxr.mozilla.org/seamonkey/source/layout/doc/overview.html">Layout + Documentation Overview</a> and the Layout DocumentationTemplates + (<a + href="http://lxr.mozilla.org/seamonkey/source/layout/doc/hld-template.html">High + Level Design Template</a> / <a + href="http://lxr.mozilla.org/seamonkey/source/layout/doc/dd-template.html">Detailed + Design Template</a>). +</i> +</blockquote> + +<hr width="100%" size="2"> + +<div align="left" + style="border: 1px solid blue; margin: auto; width: 65%;"><big><b>Legend</b></big> +<ul> + <li class="good">Black: complete and believed to be up to date (class='good')</li> + <li class="wip">Blue: incomplete or work in progress (class='wip')</li> + <li class="ood">Red: out of date or innacurate (class='ood', bug should be filed and bug number / link noted)</li> + <li class="unassigned">Green: unassigned work</li> + </li> +</ul> +</div> + +<h2><a name="TopicIndex"></a>Topic Indices</h2> + +<div style="border: 1px solid black; margin: 1em; padding: 1em;"> + <p class="wip">What is Layout? The High Level Layout Overview (attinasi) + <p class="wip">Debugging Layout (bernd) + <p class="unassigned">How Reflow works + <p class="wip">Tables balancing (karnaze) + <p class="wip">Table Borders collapsing (karnaze) + <p class="wip">Block in Inline situations (kin) + <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/HLD-SpaceManager.html">Managing Floats</a> + <p class="unassigned">Text Measurement and Text Breaking + <p class="unassigned">Image loading and display + <p class="unassigned">Margin Collapsing + <p class="unassigned">Scrolling Blocks + <p class="unassigned">Box and Block interactions + <p class="wip">Printing and Print Preview (rods) + <p class="unassigned">Plugins: the object frame and related layout classes +</div> + +<h2><a name="ClasscomponentIndex"></a>Class and Component Indices</h2> + +<div style="border: 1px solid black; margin: 1em; padding: 1em;"> + <p class="unassigned">Presentation Shell and Context: High Level / Detailed + <p class="unassigned">Frames and the Frame Manager: High Level / Detailed + <p class="good">Reflow: <a href="http://www.mozilla.org/newlayout/doc/reflow.html">High Level (waterson)</a> / <span class="unassigned">Detailed</span> + <p class="unassigned">Block and Line layout: High Level / Detailed + <p class="unassigned">TextFrame - Text Measurement and Line Breaking: High Level / Detailed + <p class="wip">PageSequenceFrame and PageFrame: High Level / Detailed (rods) + <p class="unassigned">Object Frame: High Level / Detailed + <p class="good">Space Manager: + <a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/HLD-SpaceManager.html">High Level</a> / + <a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/DD-SpaceManager.html">Detailed</a> + <p class="wip">Layout Debug Plugin: high Level / Detailed (dcone) +</div> + +<h2><a name="HowTo"></a>How To / Tech Notes</h2> + +<div style="border: 1px solid black; margin: 1em; padding: 1em;"> + <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/frame_reflow_debug.html">How to Debug Reflow </a> + <p class="good"><a href="http://www.mozilla.org/newlayout/doc/block-and-line.html">Waterson's Block and Line Cheat Sheet</a> + <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/adding-style-props.html">How to add Style Properties</a> + <p class="unassigned">Measuring Layout Performance + <p class="wip"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/regression_tests.html">Running the Regression Tests (bernd/dcone)</a> + <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/debugtable.html">Debugging Table Reflow</a> +</div> + +<hr width="100%" size="2"> + <p>Authors: + <ul> + <li>Marc Attinasi (attinasi@netscape.com)</li> + </ul> + <p>Document History: + <ul> + <li>05/06/2002 - Marc Attinasi: created</li> + <li>05/13/2002 - Marc Attinasi: added Block and Line Cheat Sheet, and link to existing Reflow document</li> + <li>05/21/2002 - Marc Attinasi: added Bernd's Table Reflow Debugging How-To (thanks Bernd!)</li> + <li>05/21/2002 - Bernd Mielke: added Frame Reflow Debugging How-To</li> + <li>06/16/2002 - Bernd Mielke: added layout regression test description</li> + </ul> + +</body> +</html> |