1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/layout/doc/index.html Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,126 @@
1.4 +<!-- This Source Code Form is subject to the terms of the Mozilla Public
1.5 + - License, v. 2.0. If a copy of the MPL was not distributed with this
1.6 + - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
1.7 +
1.8 +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1.9 +<html>
1.10 +<head>
1.11 + <title>Layout Documentation Index Page</title>
1.12 +
1.13 + <meta http-equiv="content-type"
1.14 + content="text/html; charset=ISO-8859-1">
1.15 +
1.16 + <style>
1.17 + /* colors for status of documents */
1.18 + *.ood { color: red !important; }
1.19 + *.good { color: black !important; }
1.20 + *.wip { color: blue !important; }
1.21 + *.unassigned { color: green !important; }
1.22 + /* inherit the colors into the links */
1.23 + p > a { color: inherit; }
1.24 + </style>
1.25 +</head>
1.26 +<body>
1.27 +
1.28 +<h1>Layout Technical Documentation: Primary Index</h1>
1.29 +<p class="wip">Document Status: Work In Progress (attinasi)
1.30 +<p>The goal of this document is to provide extensive links to documentation
1.31 +on the Gecko Layout components and classes. There are two sections containing
1.32 +links to the documents, and there is overlap between these sections by
1.33 +design. First, there is a '<a href="#TopicIndex">Topics</a>' section,
1.34 +where documentation is listed by generic topics, more or less free-form
1.35 +and ad-hoc. Second, there is a '<a href="#ClasscomponentIndex">Class and
1.36 +Component</a>' section, where specific classes and components are listed,
1.37 +mapping naturally to the source code. All documents should be indexed in
1.38 +both sections, so pick the index that corresponds to what you are thinking
1.39 +about. A <a href="#HowTo">Tech Notes section</a> is also included to help
1.40 +contributors find information on small topics and issues, including simple
1.41 +'How To' cookbooks.
1.42 +
1.43 +<p><blockquote>
1.44 +<i>For information about the structure of layout documents, see the <a
1.45 + href="http://lxr.mozilla.org/seamonkey/source/layout/doc/overview.html">Layout
1.46 + Documentation Overview</a> and the Layout DocumentationTemplates
1.47 + (<a
1.48 + href="http://lxr.mozilla.org/seamonkey/source/layout/doc/hld-template.html">High
1.49 + Level Design Template</a> / <a
1.50 + href="http://lxr.mozilla.org/seamonkey/source/layout/doc/dd-template.html">Detailed
1.51 + Design Template</a>).
1.52 +</i>
1.53 +</blockquote>
1.54 +
1.55 +<hr width="100%" size="2">
1.56 +
1.57 +<div align="left"
1.58 + style="border: 1px solid blue; margin: auto; width: 65%;"><big><b>Legend</b></big>
1.59 +<ul>
1.60 + <li class="good">Black: complete and believed to be up to date (class='good')</li>
1.61 + <li class="wip">Blue: incomplete or work in progress (class='wip')</li>
1.62 + <li class="ood">Red: out of date or innacurate (class='ood', bug should be filed and bug number / link noted)</li>
1.63 + <li class="unassigned">Green: unassigned work</li>
1.64 + </li>
1.65 +</ul>
1.66 +</div>
1.67 +
1.68 +<h2><a name="TopicIndex"></a>Topic Indices</h2>
1.69 +
1.70 +<div style="border: 1px solid black; margin: 1em; padding: 1em;">
1.71 + <p class="wip">What is Layout? The High Level Layout Overview (attinasi)
1.72 + <p class="wip">Debugging Layout (bernd)
1.73 + <p class="unassigned">How Reflow works
1.74 + <p class="wip">Tables balancing (karnaze)
1.75 + <p class="wip">Table Borders collapsing (karnaze)
1.76 + <p class="wip">Block in Inline situations (kin)
1.77 + <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/HLD-SpaceManager.html">Managing Floats</a>
1.78 + <p class="unassigned">Text Measurement and Text Breaking
1.79 + <p class="unassigned">Image loading and display
1.80 + <p class="unassigned">Margin Collapsing
1.81 + <p class="unassigned">Scrolling Blocks
1.82 + <p class="unassigned">Box and Block interactions
1.83 + <p class="wip">Printing and Print Preview (rods)
1.84 + <p class="unassigned">Plugins: the object frame and related layout classes
1.85 +</div>
1.86 +
1.87 +<h2><a name="ClasscomponentIndex"></a>Class and Component Indices</h2>
1.88 +
1.89 +<div style="border: 1px solid black; margin: 1em; padding: 1em;">
1.90 + <p class="unassigned">Presentation Shell and Context: High Level / Detailed
1.91 + <p class="unassigned">Frames and the Frame Manager: High Level / Detailed
1.92 + <p class="good">Reflow: <a href="http://www.mozilla.org/newlayout/doc/reflow.html">High Level (waterson)</a> / <span class="unassigned">Detailed</span>
1.93 + <p class="unassigned">Block and Line layout: High Level / Detailed
1.94 + <p class="unassigned">TextFrame - Text Measurement and Line Breaking: High Level / Detailed
1.95 + <p class="wip">PageSequenceFrame and PageFrame: High Level / Detailed (rods)
1.96 + <p class="unassigned">Object Frame: High Level / Detailed
1.97 + <p class="good">Space Manager:
1.98 + <a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/HLD-SpaceManager.html">High Level</a> /
1.99 + <a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/DD-SpaceManager.html">Detailed</a>
1.100 + <p class="wip">Layout Debug Plugin: high Level / Detailed (dcone)
1.101 +</div>
1.102 +
1.103 +<h2><a name="HowTo"></a>How To / Tech Notes</h2>
1.104 +
1.105 +<div style="border: 1px solid black; margin: 1em; padding: 1em;">
1.106 + <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/frame_reflow_debug.html">How to Debug Reflow </a>
1.107 + <p class="good"><a href="http://www.mozilla.org/newlayout/doc/block-and-line.html">Waterson's Block and Line Cheat Sheet</a>
1.108 + <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/adding-style-props.html">How to add Style Properties</a>
1.109 + <p class="unassigned">Measuring Layout Performance
1.110 + <p class="wip"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/regression_tests.html">Running the Regression Tests (bernd/dcone)</a>
1.111 + <p class="good"><a href="http://lxr.mozilla.org/seamonkey/source/layout/doc/debugtable.html">Debugging Table Reflow</a>
1.112 +</div>
1.113 +
1.114 +<hr width="100%" size="2">
1.115 + <p>Authors:
1.116 + <ul>
1.117 + <li>Marc Attinasi (attinasi@netscape.com)</li>
1.118 + </ul>
1.119 + <p>Document History:
1.120 + <ul>
1.121 + <li>05/06/2002 - Marc Attinasi: created</li>
1.122 + <li>05/13/2002 - Marc Attinasi: added Block and Line Cheat Sheet, and link to existing Reflow document</li>
1.123 + <li>05/21/2002 - Marc Attinasi: added Bernd's Table Reflow Debugging How-To (thanks Bernd!)</li>
1.124 + <li>05/21/2002 - Bernd Mielke: added Frame Reflow Debugging How-To</li>
1.125 + <li>06/16/2002 - Bernd Mielke: added layout regression test description</li>
1.126 + </ul>
1.127 +
1.128 +</body>
1.129 +</html>
