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