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