Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

added RC4 sdocs

  • Loading branch information...
commit ad7d8a30f931528535499c6c0545cbe61b5d5e85 1 parent c0353e4
wbamberg wbamberg authored

Showing 360 changed files with 27,334 additions and 0 deletions. Show diff stats Hide diff stats

  1. +205 0 base.html
  2. +124 0 css/api-reference.css
  3. +160 0 css/base.css
  4. +139 0 css/footer.css
  5. +77 0 css/header.css
  6. +299 0 css/sdk-docs.css
  7. +475 0 dev-guide/addon-development/about.html
  8. +485 0 dev-guide/addon-development/annotator/annotator.html
  9. +754 0 dev-guide/addon-development/annotator/creating.html
  10. +638 0 dev-guide/addon-development/annotator/displaying.html
  11. +505 0 dev-guide/addon-development/annotator/overview.html
  12. +781 0 dev-guide/addon-development/annotator/storing.html
  13. +550 0 dev-guide/addon-development/annotator/widget.html
  14. +493 0 dev-guide/addon-development/api-idioms.html
  15. +462 0 dev-guide/addon-development/api-intro.html
  16. +593 0 dev-guide/addon-development/api-modules.html
  17. +1,220 0 dev-guide/addon-development/cfx-tool.html
  18. +509 0 dev-guide/addon-development/commonjs.html
  19. +482 0 dev-guide/addon-development/console.html
  20. +590 0 dev-guide/addon-development/events.html
  21. +470 0 dev-guide/addon-development/getting-started.html
  22. +468 0 dev-guide/addon-development/guides.html
  23. +651 0 dev-guide/addon-development/implementing-reusable-module.html
  24. +739 0 dev-guide/addon-development/implementing-simple-addon.html
  25. +531 0 dev-guide/addon-development/installation.html
  26. +562 0 dev-guide/addon-development/module-search.html
  27. +567 0 dev-guide/addon-development/package-spec.html
  28. +466 0 dev-guide/addon-development/program-id.html
  29. +465 0 dev-guide/addon-development/reference.html
  30. +591 0 dev-guide/addon-development/troubleshooting.html
  31. +465 0 dev-guide/addon-development/tutorials.html
  32. +559 0 dev-guide/addon-development/two-types-of-scripts.html
  33. +913 0 dev-guide/addon-development/web-content.html
  34. +507 0 dev-guide/appendices/credits.html
  35. +513 0 dev-guide/appendices/glossary.html
  36. +499 0 dev-guide/module-development/about.html
  37. +511 0 dev-guide/module-development/best-practices.html
  38. +530 0 dev-guide/module-development/chrome.html
  39. +530 0 dev-guide/module-development/e10s.html
  40. +530 0 dev-guide/module-development/globals.html
  41. +461 0 dev-guide/module-development/guides.html
  42. +461 0 dev-guide/module-development/reference.html
  43. +464 0 dev-guide/module-development/tutorials.html
  44. +511 0 dev-guide/module-development/xpi.html
  45. +485 0 dev-guide/welcome.html
  46. +485 0 index.html
  47. +19 0 js/jquery.js
  48. +129 0 js/main.js
  49. +24 0 md/dev-guide/addon-development/about.md
  50. +27 0 md/dev-guide/addon-development/annotator/annotator.md
  51. +340 0 md/dev-guide/addon-development/annotator/creating.md
  52. +209 0 md/dev-guide/addon-development/annotator/displaying.md
  53. +59 0 md/dev-guide/addon-development/annotator/overview.md
  54. +365 0 md/dev-guide/addon-development/annotator/storing.md
  55. +111 0 md/dev-guide/addon-development/annotator/widget.md
  56. +50 0 md/dev-guide/addon-development/api-idioms.md
  57. +8 0 md/dev-guide/addon-development/api-intro.md
  58. +195 0 md/dev-guide/addon-development/api-modules.md
  59. +842 0 md/dev-guide/addon-development/cfx-tool.md
  60. +60 0 md/dev-guide/addon-development/commonjs.md
  61. +42 0 md/dev-guide/addon-development/console.md
  62. +149 0 md/dev-guide/addon-development/events.md
  63. +19 0 md/dev-guide/addon-development/getting-started.md
  64. +18 0 md/dev-guide/addon-development/guides.md
  65. +217 0 md/dev-guide/addon-development/implementing-reusable-module.md
  66. +325 0 md/dev-guide/addon-development/implementing-simple-addon.md
  67. +90 0 md/dev-guide/addon-development/installation.md
  68. +113 0 md/dev-guide/addon-development/module-search.md
  69. +104 0 md/dev-guide/addon-development/package-spec.md
  70. +12 0 md/dev-guide/addon-development/program-id.md
  71. +17 0 md/dev-guide/addon-development/reference.md
  72. +186 0 md/dev-guide/addon-development/troubleshooting.md
  73. +12 0 md/dev-guide/addon-development/tutorials.md
  74. +117 0 md/dev-guide/addon-development/two-types-of-scripts.md
Sorry, we could not display the entire diff because too many files (360) changed.
205 base.html
... ... @@ -0,0 +1,205 @@
  1 +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
  2 +"http://www.w3.org/TR/html4/strict.dtd">
  3 +<html lang="en">
  4 +<head>
  5 + <base >
  6 + <meta http-equiv="Content-type" content="text/html; charset=utf-8">
  7 + <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
  8 + <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>
  9 + <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushXml.js"></script>
  10 + <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushJScript.js"></script>
  11 + <link rel="stylesheet" type="text/css" media="all" href="css/base.css">
  12 + <link rel="stylesheet" type="text/css" media="all" href="css/header.css">
  13 + <link rel="stylesheet" type="text/css" media="all" href="css/footer.css">
  14 + <link rel="stylesheet" type="text/css" media="all" href="css/sdk-docs.css">
  15 + <link rel="stylesheet" type="text/css" media="all" href="css/api-reference.css">
  16 + <link rel="stylesheet" type="text/css" href="syntaxhighlighter/styles/shCore.css">
  17 + <link rel="stylesheet" type="text/css" href="syntaxhighlighter/styles/shThemeDefault.css">
  18 + <!--[if IE]>
  19 + <style type="text/css">
  20 + .package-summary .module,
  21 + .package-entry .module,
  22 + .package-detail .module {
  23 + display: block;
  24 + }
  25 + </style>
  26 + <![endif]-->
  27 +
  28 + <link rel="shortcut icon" type="image/x-icon" href="media/favicon.png">
  29 + <title></title>
  30 +</head>
  31 +<body>
  32 +
  33 +<header id="global-header">
  34 + <div class="funnel">
  35 + <a id="mozilla-tab" href="http://www.mozilla.org/?ref=logo">Mozilla</a>
  36 + <div class="menu">
  37 + <p>
  38 + <a href="https://addons.mozilla.org/en-US/developers/">Back to Developer Hub</a>
  39 + </p>
  40 + </div>
  41 +</header>
  42 +
  43 +
  44 +<header id="site-header">
  45 + <div class="funnel">
  46 + <h1>
  47 + <a href="dev-guide/welcome.html">Add-on SDK<span></span></a>
  48 + </h1>
  49 + </div>
  50 +</header>
  51 +
  52 + <div id="container">
  53 +
  54 + <div id="columns">
  55 +
  56 + <div id="main-content-column" class="column">
  57 + <div id="toc"></div>
  58 + <div id="main-content"></div>
  59 + </div>
  60 +
  61 + <div id="sidebar" class="column">
  62 + <div class="sidebar-section" id="addon-development">
  63 + <h2 class="sidebar-section-header"><a href="dev-guide/addon-development/about.html">Developer Guide</a></h2>
  64 + <div class="sidebar-section-contents" id="default-section-contents">
  65 +
  66 + <div class="sidebar-subsection">
  67 + <h3><a href="dev-guide/addon-development/installation.html">Installation</a></h3>
  68 + <div class="divider"></div>
  69 + <h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/tutorials.html">Tutorials</a></h3>
  70 + <div class="sidebar-subsection-contents">
  71 + <ul>
  72 + <li><h4><a href="dev-guide/addon-development/getting-started.html">Getting Started</a></h4>
  73 + <ul>
  74 + <li><a href="dev-guide/addon-development/implementing-simple-addon.html">A Simple Add-on</a></li>
  75 + <li><a href="dev-guide/addon-development/commonjs.html">CommonJS</a></li>
  76 + <li><a href="dev-guide/addon-development/implementing-reusable-module.html">Reusable Modules</a></li>
  77 + <li><a href="dev-guide/addon-development/troubleshooting.html">Troubleshooting</a></li>
  78 + </ul></li>
  79 + <li><h4><a href="dev-guide/addon-development/api-intro.html" >Introducing the APIs</a></h4>
  80 + <ul>
  81 + <li><a href="dev-guide/addon-development/api-idioms.html">Common Idioms</a></li>
  82 + <li><a href="dev-guide/addon-development/api-modules.html">API Overview</a></li>
  83 + </ul></li>
  84 + <li><h4><a href="dev-guide/addon-development/annotator/annotator.html">Annotator: a More Complex Add-on</a></h4>
  85 + <ul>
  86 + <li><a href="dev-guide/addon-development/annotator/overview.html">Design Overview</a></li>
  87 + <li><a href="dev-guide/addon-development/annotator/widget.html">Implementing the Widget</a></li>
  88 + <li><a href="dev-guide/addon-development/annotator/creating.html">Creating Annotations</a></li>
  89 + <li><a href="dev-guide/addon-development/annotator/storing.html">Storing Annotations</a></li>
  90 + <li><a href="dev-guide/addon-development/annotator/displaying.html">Displaying Annotations</a></li>
  91 + </ul></li>
  92 + </ul>
  93 + </div>
  94 + </div>
  95 +
  96 + <div class="sidebar-subsection">
  97 + <div class="divider"></div>
  98 + <h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/guides.html">Programming Guides</a></h3>
  99 + <div class="sidebar-subsection-contents">
  100 + <ul>
  101 + <li><h4><a href="dev-guide/addon-development/two-types-of-scripts.html">Two Types of Scripts</a></h4></li>
  102 + <li><h4><a href="dev-guide/addon-development/events.html">Working with Events</a></h4></li>
  103 + <li><h4><a href="dev-guide/addon-development/web-content.html">Working with Content Scripts</a></h4></li>
  104 + <li><h4><a href="dev-guide/addon-development/program-id.html">The Program ID</a></h4></li>
  105 + <li><h4><a href="dev-guide/addon-development/module-search.html">Module Search</a></h4></li>
  106 + </ul>
  107 + </div>
  108 + </div>
  109 +
  110 + <div class="sidebar-subsection">
  111 + <div class="divider"></div>
  112 + <h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/reference.html">Reference</a></h3>
  113 + <div class="sidebar-subsection-contents always-show">
  114 + <ul>
  115 + <li id="high-level-package-summaries"></li>
  116 + <li><h4><a href="dev-guide/addon-development/console.html">console</a></h4></li>
  117 + <li><h4><a href="dev-guide/addon-development/cfx-tool.html">cfx</a></h4></li>
  118 + <li><h4><a href="dev-guide/addon-development/package-spec.html">Package Specification</a></h4></li>
  119 + </ul>
  120 + </div>
  121 + </div>
  122 +
  123 + </div>
  124 + </div>
  125 +
  126 + <div class="sidebar-section" id="module-development">
  127 + <h2 class="sidebar-section-header"><a href="dev-guide/module-development/about.html">Internals Guide</a></h2>
  128 + <div class="sidebar-section-contents">
  129 +
  130 + <div class="sidebar-subsection">
  131 + <h3 class="sidebar-subsection-header"><a href="dev-guide/module-development/guides.html">Programming Guides</a></h3>
  132 + <div class="sidebar-subsection-contents">
  133 + <ul>
  134 + <li><h4><a href="dev-guide/module-development/best-practices.html">Low-Level Module Best Practices</a></h4>
  135 + <li><h4><a href="dev-guide/module-development/chrome.html">Chrome Authority</a></h4>
  136 + <li><h4><a href="dev-guide/module-development/xpi.html">XPI Generation</a></h4>
  137 + <li><h4><a href="dev-guide/module-development/e10s.html">Out-of-Process Add-ons</a></h4>
  138 + </ul>
  139 + </div>
  140 + </div>
  141 +
  142 + <div class="sidebar-subsection">
  143 + <div class="divider"></div>
  144 + <h3 class="sidebar-subsection-header"><a href="dev-guide/module-development/reference.html">Reference</a></h3>
  145 + <div class="sidebar-subsection-contents">
  146 + <ul>
  147 + <li id="low-level-package-summaries"></li>
  148 + <li><h4><a href="dev-guide/module-development/globals.html">Globals</a></h4></li>
  149 + </ul>
  150 + </div>
  151 + </div>
  152 + </div>
  153 + </div>
  154 +
  155 + <div class="sidebar-section" id="appendices">
  156 + <h3><a href="https://wiki.mozilla.org/Labs/Jetpack/Release_Notes">Release Notes</a></h3>
  157 + <div class="divider"></div>
  158 + <h3><a href="https://wiki.mozilla.org/Labs/Jetpack">Jetpack Wiki</a></h3>
  159 + <div class="divider"></div>
  160 + <h3><a href="dev-guide/appendices/glossary.html">Glossary</a></h3>
  161 + <div class="divider"></div>
  162 + <h3><a href="dev-guide/appendices/credits.html">Credits</a></h3>
  163 +
  164 + </div>
  165 +<!--end of sidebar column-->
  166 + </div>
  167 +<!--end of 'columns'-->
  168 +<div class="clearfooter"></div>
  169 +</div>
  170 +</div>
  171 +
  172 +<div role="contentinfo" id="footer">
  173 + <div class="section">
  174 + <img alt="" src="media/footer-logo-med.png" class="footerlogo">
  175 + <div id="social-footer">
  176 + <ul>
  177 + <li>get to know <b>add-ons</b></li>
  178 + <li><a href="https://addons.mozilla.org/en-US/firefox/about">About</a></li>
  179 + <li><a href="http://blog.mozilla.com/addons">Blog</a></li>
  180 + <li class="footer-devhub-link"><a href="https://addons.mozilla.org/en-US/developers/">Developer Hub</a></li>
  181 + <li><a href="https://addons.mozilla.org/en-US/firefox/faq">FAQ</a></li>
  182 + <li><a href="https://forums.addons.mozilla.org">Forum</a></li>
  183 + </ul>
  184 + </div>
  185 +
  186 + <div id="copyright">
  187 + <p id="footer-links">
  188 + <a href="http://mozilla.com/privacy-policy.html">Privacy Policy</a> &nbsp;|&nbsp;
  189 + <a href="http://mozilla.com/about/legal.html">Legal Notices</a> &nbsp;|&nbsp;
  190 + <a href="http://mozilla.com/legal/fraud-report/index.html">Report Trademark Abuse</a>
  191 + &nbsp;|&nbsp;<a href="https://addons.mozilla.org/z/en-US/developers/" class="mobile-link">View Mobile Site</a>
  192 + </p>
  193 + <p>
  194 + Except where otherwise <a href="http://mozilla.com/about/legal.html#site">noted</a>, content on this site is licensed under the <br> <a href="http://creativecommons.org/licenses/by-sa/3.0/"> Creative Commons Attribution Share-Alike License v3.0 </a> or any later version.
  195 + </p>
  196 + </div>
  197 + </div>
  198 +</div>
  199 +
  200 +<script type="text/javascript" src="js/jquery.js"></script>
  201 +<script type="text/javascript" src="js/main.js"></script>
  202 +
  203 +</body>
  204 +
  205 +</html>
124 css/api-reference.css
... ... @@ -0,0 +1,124 @@
  1 +/*
  2 +Styles that are specific to the API reference doc structure
  3 +*/
  4 +
  5 +/*
  6 +Some global styles for api_reference
  7 +*/
  8 +
  9 +.api_reference p {
  10 + margin-top: 0px;
  11 + margin-bottom: 5px;
  12 +}
  13 +
  14 +.api_reference .datatype {
  15 + font-style: italic;
  16 +}
  17 +
  18 +/***
  19 +HEADINGS
  20 +Text title for some collection of API elements, like "Properties" or "Methods".
  21 +***/
  22 +
  23 +/* top level heading: something like "API Reference" */
  24 +h2.api_header {
  25 + font-size: 200%;
  26 + margin-top: 30px;
  27 + margin-bottom: 10px;
  28 +}
  29 +
  30 +/* next-level heading: something like "Classes", "Global Functions" */
  31 +h3.api_header {
  32 + font-size: 150%;
  33 + margin-top: 20px;
  34 + margin-bottom: 10px;
  35 + padding: 3px;
  36 + border: solid 1px #e0effd;
  37 + background: #e0effd;
  38 + -moz-border-radius: 5px;
  39 +}
  40 +
  41 +/* next-level heading: something like "Methods", "Object properties" */
  42 +.api_reference > .api_component_group > .api_component > .api_component_group > .api_header {
  43 + font-size: 125%;
  44 + margin-top: 20px;
  45 + margin-bottom: 5px;
  46 + border-bottom: solid 2px #e0effd;
  47 +}
  48 +
  49 +/***
  50 +NAMES
  51 +Name of some API component, like widget or postMessage()
  52 +***/
  53 +
  54 +/* default style for all names */
  55 +.api_name {
  56 + font-weight: bold;
  57 +}
  58 +
  59 +/* top level api component: module-level classes, functions, properties */
  60 +h4.api_name {
  61 + font-weight: normal;
  62 + font-size: 150%;
  63 + padding: 3px;
  64 + border: solid 1px #e0effd;
  65 + background: #e0effd;
  66 + -moz-border-radius: 5px;
  67 + margin-bottom: 5px;
  68 +}
  69 +
  70 +/* next level API component: methods or object properties */
  71 +.api_reference > .api_component_group > .api_component > .api_component_group > .api_component > .api_name {
  72 + font-size: 120%;
  73 + font-weight: bold;
  74 + margin-bottom: 0px;
  75 +}
  76 +
  77 +/***
  78 +Spacing components and component groups
  79 +***/
  80 +
  81 +/*
  82 +Top level API component, like a global class, function, or property
  83 +*/
  84 +.api_reference > .api_component_group > .api_component {
  85 + margin-bottom: 50px;
  86 +}
  87 +
  88 +/*
  89 +Next-level API component, like a class method
  90 +*/
  91 +.api_reference > .api_component_group > .api_component > .api_component_group > .api_component {
  92 + margin-bottom: 20px;
  93 +}
  94 +
  95 +/*
  96 +All collections of API components
  97 +*/
  98 +.api_component_group {
  99 + margin-bottom: 30px;
  100 +}
  101 +
  102 +/***PARAMETERS and RETURNS***/
  103 +/*
  104 +Parameters and returns have a grey background
  105 +*/
  106 +.parameter_set, .returns {
  107 + background-color: #f0f8ff;
  108 + -moz-border-radius: 5px;
  109 +}
  110 +
  111 +/*
  112 +Parameter components are divided by a thin border
  113 +*/
  114 +.parameter_set .api_component {
  115 + padding: 3px;
  116 + border-top: 2px solid rgba(255,255,255,.3);
  117 +}
  118 +
  119 +/*
  120 +Subcomponents of parameters are indented
  121 +*/
  122 +.parameter_set > .api_component > .api_component {
  123 + padding-left: 20px;
  124 +}
160 css/base.css
... ... @@ -0,0 +1,160 @@
  1 +* {
  2 + background: transparent;
  3 + border: 0;
  4 + font-size: 100%;
  5 + margin: 0;
  6 + padding: 0;
  7 + vertical-align: baseline;
  8 +}
  9 +
  10 +html {
  11 + background-color: #fff;
  12 + background-image: url(../media/bg-header.png);
  13 + background-position: left top;
  14 + background-repeat: repeat-x;
  15 +}
  16 +
  17 +html, body {
  18 + height: 100%;
  19 +}
  20 +
  21 +body {
  22 + color: #444;
  23 + font-size: 13px;
  24 + line-height: 1.538em;
  25 + margin: 0 auto;
  26 + min-width: 780px;
  27 + position: relative;
  28 + font-family: "helvetica neue", arial, helvetica, sans-serif;
  29 + font-style: normal;
  30 +}
  31 +
  32 +table {
  33 + width: 100%;
  34 + border-collapse: collapse;
  35 +}
  36 +
  37 +table, td, tr {
  38 + border: 1px black solid;
  39 +}
  40 +
  41 +td {
  42 + padding: 0.5em;
  43 +}
  44 +
  45 +/* Rule to fix quirks-mode inheritance behavior */
  46 +
  47 +table, caption {
  48 + font-size: inherit;
  49 + font-weight: inherit;
  50 + font-style: inherit;
  51 + font-variant: inherit;
  52 +}
  53 +
  54 +table.meta-table, .meta-table td, .meta-table tr {
  55 + vertical-align: top;
  56 + border: none;
  57 + padding: 0;
  58 + padding-top: 0.25em;
  59 + padding-bottom: 0.25em;
  60 + padding-right: 5em;
  61 +}
  62 +
  63 +table.meta-table {
  64 + margin-top: 0.5em;
  65 + border-top: 1px dotted gray;
  66 + border-bottom: 1px dotted gray;
  67 +}
  68 +
  69 +a:link {
  70 + color: #003595;
  71 + text-decoration: none;
  72 +}
  73 +
  74 +a:visited {
  75 + color: #003595;
  76 + text-decoration: none;
  77 +}
  78 +
  79 +a:hover, a:focus, a:active {
  80 + color: #003595;
  81 + text-decoration: underline;
  82 +}
  83 +
  84 +pre, code, kbd, tt, samp, tt {
  85 + font-family: "andale mono", monospace;
  86 +}
  87 +
  88 +h1 {
  89 + font-size: 2.571em;
  90 + line-height: 1em;
  91 + margin-bottom: .5833em;
  92 + margin-top: .1667em;
  93 + font-family: Georgia, serif;
  94 + font-weight: normal;
  95 +}
  96 +
  97 +h2 {
  98 + color: #011234;
  99 + font-size: 2.154em;
  100 + font-weight: normal;
  101 + line-height: 1em;
  102 + margin-bottom: .5em;
  103 + margin-top: .5em;
  104 + font-family: Georgia, serif;
  105 + font-style: italic;
  106 +}
  107 +
  108 +h3 {
  109 + color: #011234;
  110 + font-size: 1.385em;
  111 + font-weight: normal;
  112 + line-height: 1.111em;
  113 + margin-bottom: .778em;
  114 + margin-top: 1.556em;
  115 + font-family: Georgia, serif;
  116 + font-style: italic;
  117 +}
  118 +
  119 +h4 {
  120 + color: #235;
  121 + font-size: 1em;
  122 +}
  123 +
  124 +h5, h6 {
  125 + font-size: 1em;
  126 +}
  127 +
  128 +li {
  129 + margin-left: 2em;
  130 +}
  131 +
  132 +ol {
  133 + list-style-type: decimal;
  134 + margin-left: 2em;
  135 +}
  136 +
  137 +dt {
  138 + font-weight: bold;
  139 + margin-top: 1.5em;
  140 +}
  141 +
  142 +ul ul, ol ol, ol ul, ul ol {
  143 + margin-bottom: 0;
  144 +}
  145 +
  146 +p, ul, ol, dl, address, table, pre, form, fieldset {
  147 + font-size: 1em;
  148 + margin-bottom: 1.5em;
  149 +}
  150 +
  151 +th, td {
  152 + text-align: left;
  153 +}
  154 +
  155 +@font-face {
  156 + font-family: 'MetaBlack';
  157 + font-style: normal;
  158 + font-weight: bold;
  159 + src: url('https://www.mozilla.com/img/fonts/MetaWebPro-Black.woff') format('woff');
  160 +}
139 css/footer.css
... ... @@ -0,0 +1,139 @@
77 css/header.css
... ... @@ -0,0 +1,77 @@
  1 +header {
  2 + display: block;
  3 +}
  4 +
  5 +#global-header {
  6 + border-top: 2px solid #686868;
  7 +}
  8 +
  9 +#global-header #mozilla-tab {
  10 + background: url("../media/mozilla-tab.png") no-repeat scroll 0 0 transparent;
  11 + height: 50px;
  12 + position: absolute;
  13 + right: 0;
  14 + text-indent: -10000em;
  15 + top: 0;
  16 + width: 118px;
  17 + z-index: 1;
  18 +}
  19 +
  20 +#global-header .menu {
  21 + font-size: 12px;
  22 + position: absolute;
  23 + right: 118px;
  24 + top: 0;
  25 + z-index: 1;
  26 +}
  27 +
  28 +#global-header .menu p {
  29 + border-left: 1px solid #9Fa7aF;
  30 + display: inline-block;
  31 + height: 32px;
  32 + line-height: 32px;
  33 + padding: 0 1em;
  34 +}
  35 +
  36 +#site-header {
  37 + margin: 35px 0 0;
  38 +}
  39 +
  40 +#site-header h1, #site-header #site-nav {
  41 + margin-left: 64px;
  42 +}
  43 +
  44 +#site-header h1 {
  45 + display: inline;
  46 +}
  47 +
  48 +#site-header h1 a {
  49 + -moz-transition-duration: 0.2s;
  50 + -moz-transition-property: color, text-shadow;
  51 + color: #333333;
  52 + display: inline-block;
  53 + font-family: MetaBlack;
  54 + font-size: 40px;
  55 + font-weight: bold;
  56 + letter-spacing: -1px;
  57 + text-decoration: none;
  58 + text-transform: uppercase;
  59 +}
  60 +
  61 +#site-header h1 a span {
  62 + background: url("../media/firefox-logo.png") no-repeat scroll 0 0 transparent;
  63 + height: 62px;
  64 + left: 0;
  65 + position: absolute;
  66 + top: 0;
  67 + width: 54px;
  68 +}
  69 +
  70 +#site-header h1 a:hover, #site-header h1 a:focus {
  71 + color: #043b84;
  72 + text-shadow: 0 0 40px #ffffff, 0 0 20px #ffffff, 0 0 10px #ffffff, 0 0 10px #ffffff, 0 0 10px #ffffff;
  73 +}
  74 +
  75 +#site-header #site-search {
  76 + display: none;
  77 +}
299 css/sdk-docs.css
... ... @@ -0,0 +1,299 @@
  1 +html, body {
  2 + min-width: 570px; /* 2 x sidebar fullwidth + main-content padding */
  3 + height: 100%;
  4 +}
  5 +
  6 +#columns {
  7 + padding-left: 250px; /* sidebar width + sidebar padding */
  8 + padding-right: 65px; /* main-content padding*/
  9 + padding-top: 40px;
  10 + min-height: 100%;
  11 + margin-bottom: 170px;
  12 + position: relative;
  13 +}
  14 +
  15 +.funnel .menu {
  16 + padding-right: 50px; /* main-content padding*/
  17 +}
  18 +
  19 +#mozilla-tab {
  20 + padding-right: 50px; /* main-content padding*/
  21 +}
  22 +
  23 +#site-header h1 a span {
  24 + top: 25px;
  25 + left: 45px;
  26 +}
  27 +
  28 +#site-header h1 a {
  29 + padding-left: 45px;
  30 +}
  31 +
  32 +#columns .column {
  33 + position: relative;
  34 + float: left;
  35 +}
  36 +
  37 +#main-content-column {
  38 + width: 100%;
  39 + padding-right: 50px;
  40 +}
  41 +
  42 +.check, .cross {
  43 + text-align: center;
  44 +}
  45 +
  46 +#sidebar {
  47 + width: 200px; /* sidebar usable width (fullwidth - padding) */
  48 + right: 300px; /* sidebar fullwidth + main-content padding */
  49 + padding-left: 30px;
  50 + padding-right: 20px;
  51 + margin-left: -100%;
  52 +}
  53 +
  54 +.api_reference h3, .api_reference h4,
  55 +.api_reference h5, .api_reference h6 {
  56 + overflow: auto;
  57 + }
  58 +
  59 +#toc {
  60 + width: 180px;
  61 + float: right;
  62 + font-size: 0.9em;
  63 + overflow: hidden;
  64 + margin-top: 0;
  65 + margin-left: 20px;
  66 + margin-bottom: 1em;
  67 +}
  68 +
  69 +#toc a {
  70 + font-family: Georgia, serif;
  71 + font-weight: normal;
  72 + font-style: italic;
  73 +}
  74 +
  75 +.title {
  76 + height: 30px;
  77 + margin-bottom: 10px;
  78 +}
  79 +
  80 +.sidebar-section, #toc {
  81 + border-style: solid;
  82 + border-color: #a0d0fb;
  83 + border-width: 1px;
  84 + -moz-border-radius: 5px;
  85 + -webkit-border-radius: 5px;
  86 + -khtml-border-radius: 5px;
  87 + border-radius: 5px;
  88 + background: #e0effd;
  89 + margin-bottom: 1.0em;
  90 +}
  91 +
  92 +.aside {
  93 + color: gray;
  94 + float: right;
  95 + padding-left: 1em;
  96 + margin-left: 1em;
  97 + margin-right: 0;
  98 + width: 25%;
  99 + border-left: 1px solid gray;
  100 +}
  101 +
  102 +#toc a {
  103 + display: block;
  104 + }
  105 +
  106 +#toc a[class = H2] {
  107 + font-size: 1.1em;
  108 + font-weight: bold;
  109 + margin-left: 0.5em;
  110 +}
  111 +
  112 +#toc a[class = H3] {
  113 + margin-left: 0.5em;
  114 + font-weight: bold;
  115 +}
  116 +
  117 +#toc a[class = H4] {
  118 + margin-left: 1.5em;
  119 + font-family: "andale mono", monospace;
  120 + font-style: normal;
  121 +}
  122 +
  123 +#toc a[class = H5] {
  124 + margin-left: 2.5em;
  125 + font-weight: bold;
  126 +}
  127 +
  128 +#toc a[class = H6] {
  129 + margin-left: 3em;
  130 + font-family: "andale mono", monospace;
  131 + font-style: normal;
  132 +}
  133 +
  134 +.warning {
  135 + margin-left: auto;
  136 + margin-right: auto;
  137 + margin-top: 2em;
  138 + margin-bottom: 2em;
  139 + display: block;
  140 + padding: 1em;
  141 + border: solid 2px black;
  142 + width: 75%;
  143 + background-color: #c63717;
  144 + color: white;
  145 +}
  146 +
  147 +.logo {
  148 + margin-left: 5px;
  149 + float: left;
  150 +}
  151 +
  152 +.meta-header {
  153 + font-weight: bold;
  154 +}
  155 +
  156 +.sidebar-section .modules {
  157 + padding-left: 25px;
  158 +}
  159 +
  160 +.package-entry .modules
  161 +.package-detail .modules {
  162 + margin: 0em;
  163 + padding-left: 0;
  164 +}
  165 +
  166 +.module {
  167 + margin-top: 0.2em;
  168 + margin-bottom: 0.2em;
  169 + padding-left: 0em;
  170 + padding-right: 0em;
  171 + margin-right: 1.0em;
  172 +}
  173 +
  174 +.package-summary .module {
  175 + padding-left: 0em;
  176 +}
  177 +
  178 +.package-summary .module,
  179 +.package-entry .module,
  180 +.package-detail .module {
  181 + display: inline;
  182 + white-space: nowrap;
  183 + margin-left: 0em;
  184 +}
  185 +
  186 +.package-detail .authors, .package-detail .dependencies,
  187 +.package-detail .version, .package-detail .license {
  188 + font-family: Monaco, Lucida Console, monospace;
  189 + font-size: 0.8em;
  190 + white-space: pre;
  191 +}
  192 +
  193 +#main-content h1 {
  194 + font-size: 2.2em;
  195 +}
  196 +
  197 +#main-content h2 {
  198 + font-size: 1.7em;
  199 +}
  200 +
  201 +.sidebar-subsection-contents {
  202 + display: none;
  203 +}
  204 +
  205 +.sidebar-subsection {
  206 + margin: 1px;
  207 +}
  208 +
  209 +.always-show {
  210 + display: normal;
  211 +}
  212 +
  213 +.sidebar-section ul {
  214 + margin-bottom: 0.2em;
  215 + list-style: none;
  216 +}
  217 +
  218 +.sidebar-section li li {
  219 + padding-left: 30px;
  220 + margin-left: 0;
  221 +}
  222 +
  223 +.sidebar-section .modules {
  224 + padding-left: 25px;
  225 +}
  226 +
  227 +.sidebar-section h2, .sidebar-section h4 {
  228 + padding-left: 10px;
  229 +}
  230 +
  231 +.sidebar-section h3 {
  232 + padding-left: 5px;
  233 +}
  234 +
  235 +.sidebar-section h2, .sidebar-section h3 {
  236 + padding-top: 5px;
  237 + padding-bottom: 5px;
  238 + margin: 0px;
  239 + font-style: normal;
  240 + font-family: arial, helvetica, sans-serif;
  241 +}
  242 +
  243 +.sidebar-section h2 {
  244 + background-color: #3b69b1;
  245 + font-family: Georgia, serif;
  246 + font-style: italic;
  247 + font-size: 1.4em;
  248 + -moz-border-radius-topleft: 5px;
  249 + -moz-border-radius-topright: 5px;
  250 + -webkit-border-radius-topleft: 5px;
  251 + -webkit-border-radius-topright: 5px;
  252 + -khtml-border-radius-topleft: 5px;
  253 + -khtml-border-radius-topright: 5px;
  254 + border-radius-topleft: 5px;
  255 + border-radius-topright: 5px;
  256 +}
  257 +
  258 +.sidebar-section h2 a {
  259 + color: white;
  260 +}
  261 +
  262 +.sidebar-section h2.current-page a {
  263 + color: #3b69b1;
  264 +}
  265 +
  266 +.sidebar-section h3 {
  267 + font-family: Georgia, serif;
  268 + font-style: italic;
  269 + font-size: 1.2em;
  270 +}
  271 +
  272 +.divider {
  273 + border-style: solid;
  274 + border-top-width: 1px;
  275 + border-color: #a0d0fb;
  276 + margin-left: 5px;
  277 + margin-right: 5px;
  278 +}
  279 +
  280 +.sidebar-section h4 {
  281 + font-weight: normal;
  282 + font-family: Georgia, serif;
  283 +
  284 +}
  285 +
  286 +.sidebar-section li {
  287 + font-family: Georgia, serif;
  288 + margin-left: 0;
  289 +}
  290 +
  291 +.sidebar-section .current-page {
  292 + background-color: white;
  293 +}
  294 +
  295 +.image-center {
  296 + margin-left: auto;
  297 + margin-right: auto;
  298 + display: block;
  299 +}
475 dev-guide/addon-development/about.html
... ... @@ -0,0 +1,475 @@
  1 +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
  2 +"http://www.w3.org/TR/html4/strict.dtd">
  3 +<html lang="en">
  4 +<head>
  5 + <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/" >
  6 + <meta http-equiv="Content-type" content="text/html; charset=utf-8">
  7 + <script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
  8 + <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCss.js"></script>
  9 + <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushXml.js"></script>
  10 + <script type="text/javascript" src="syntaxhighlighter/scripts/shBrushJScript.js"></script>
  11 + <link rel="stylesheet" type="text/css" media="all" href="css/base.css">
  12 + <link rel="stylesheet" type="text/css" media="all" href="css/header.css">
  13 + <link rel="stylesheet" type="text/css" media="all" href="css/footer.css">
  14 + <link rel="stylesheet" type="text/css" media="all" href="css/sdk-docs.css">
  15 + <link rel="stylesheet" type="text/css" media="all" href="css/api-reference.css">
  16 + <link rel="stylesheet" type="text/css" href="syntaxhighlighter/styles/shCore.css">
  17 + <link rel="stylesheet" type="text/css" href="syntaxhighlighter/styles/shThemeDefault.css">
  18 + <!--[if IE]>
  19 + <style type="text/css">
  20 + .package-summary .module,
  21 + .package-entry .module,
  22 + .package-detail .module {
  23 + display: block;
  24 + }
  25 + </style>
  26 + <![endif]-->
  27 +
  28 + <link rel="shortcut icon" type="image/x-icon" href="media/favicon.png">
  29 + <title>Developer Guide - Add-on SDK Documentation</title>
  30 +</head>
  31 +<body>
  32 +
  33 +<header id="global-header">
  34 + <div class="funnel">
  35 + <a id="mozilla-tab" href="http://www.mozilla.org/?ref=logo">Mozilla</a>
  36 + <div class="menu">
  37 + <p>
  38 + <a href="https://addons.mozilla.org/en-US/developers/">Back to Developer Hub</a>
  39 + </p>
  40 + </div>
  41 +</header>
  42 +
  43 +
  44 +<header id="site-header">
  45 + <div class="funnel">
  46 + <h1>
  47 + <a href="dev-guide/welcome.html">Add-on SDK<span></span></a>
  48 + </h1>
  49 + </div>
  50 +</header>
  51 +
  52 + <div id="container">
  53 +
  54 + <div id="columns">
  55 +
  56 + <div id="main-content-column" class="column">
  57 + <div id="toc"></div>
  58 + <div id="main-content"><h1>Developer Guide</h1>
  59 +<p>With the exception of features in the Experimental section, the APIs and
  60 +features documented in the Developer Guide are relatively stable. We intend
  61 +to add new APIs here and extend existing ones, but will avoid making
  62 +incompatible changes to them unless absolutely necessary.</p>
  63 +<h3><a href="dev-guide/addon-development/installation.html">Installation</a></h3>
  64 +<p>What you need to install the SDK.</p>
  65 +<h3><a href="dev-guide/addon-development/tutorials.html">Tutorials</a></h3>
  66 +<p>Practical explanations of how to develop add-ons with the SDK. If you're not
  67 +sure where to start, have a look at the <a href="dev-guide/addon-development/getting-started.html">Getting
  68 + Started</a> tutorial.</p>
  69 +<h3><a href="dev-guide/addon-development/guides.html">Programming Guides</a></h3>
  70 +<p>Standalone articles that provide more in-depth explanation of particular
  71 +aspects of programming with the SDK.</p>
  72 +<h3><a href="dev-guide/addon-development/reference.html">Reference</a></h3>
  73 +<p>Detailed documentation for the high-level APIs and tools in the SDK. In
  74 +particular, this section includes API reference documentation for the
  75 +high-level modules supplied in the
  76 +<a href="packages/addon-kit/addon-kit.html">addon-kit</a> package.</p></div>
  77 + </div>
  78 +
  79 + <div id="sidebar" class="column">
  80 + <div class="sidebar-section" id="addon-development">
  81 + <h2 class="sidebar-section-header"><a href="dev-guide/addon-development/about.html">Developer Guide</a></h2>
  82 + <div class="sidebar-section-contents" id="default-section-contents">
  83 +
  84 + <div class="sidebar-subsection">
  85 + <h3><a href="dev-guide/addon-development/installation.html">Installation</a></h3>
  86 + <div class="divider"></div>
  87 + <h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/tutorials.html">Tutorials</a></h3>
  88 + <div class="sidebar-subsection-contents">
  89 + <ul>
  90 + <li><h4><a href="dev-guide/addon-development/getting-started.html">Getting Started</a></h4>
  91 + <ul>
  92 + <li><a href="dev-guide/addon-development/implementing-simple-addon.html">A Simple Add-on</a></li>
  93 + <li><a href="dev-guide/addon-development/commonjs.html">CommonJS</a></li>
  94 + <li><a href="dev-guide/addon-development/implementing-reusable-module.html">Reusable Modules</a></li>
  95 + <li><a href="dev-guide/addon-development/troubleshooting.html">Troubleshooting</a></li>
  96 + </ul></li>
  97 + <li><h4><a href="dev-guide/addon-development/api-intro.html" >Introducing the APIs</a></h4>
  98 + <ul>
  99 + <li><a href="dev-guide/addon-development/api-idioms.html">Common Idioms</a></li>
  100 + <li><a href="dev-guide/addon-development/api-modules.html">API Overview</a></li>
  101 + </ul></li>
  102 + <li><h4><a href="dev-guide/addon-development/annotator/annotator.html">Annotator: a More Complex Add-on</a></h4>
  103 + <ul>
  104 + <li><a href="dev-guide/addon-development/annotator/overview.html">Design Overview</a></li>
  105 + <li><a href="dev-guide/addon-development/annotator/widget.html">Implementing the Widget</a></li>
  106 + <li><a href="dev-guide/addon-development/annotator/creating.html">Creating Annotations</a></li>
  107 + <li><a href="dev-guide/addon-development/annotator/storing.html">Storing Annotations</a></li>
  108 + <li><a href="dev-guide/addon-development/annotator/displaying.html">Displaying Annotations</a></li>
  109 + </ul></li>
  110 + </ul>
  111 + </div>
  112 + </div>
  113 +
  114 + <div class="sidebar-subsection">
  115 + <div class="divider"></div>
  116 + <h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/guides.html">Programming Guides</a></h3>
  117 + <div class="sidebar-subsection-contents">
  118 + <ul>
  119 + <li><h4><a href="dev-guide/addon-development/two-types-of-scripts.html">Two Types of Scripts</a></h4></li>
  120 + <li><h4><a href="dev-guide/addon-development/events.html">Working with Events</a></h4></li>
  121 + <li><h4><a href="dev-guide/addon-development/web-content.html">Working with Content Scripts</a></h4></li>
  122 + <li><h4><a href="dev-guide/addon-development/program-id.html">The Program ID</a></h4></li>
  123 + <li><h4><a href="dev-guide/addon-development/module-search.html">Module Search</a></h4></li>
  124 + </ul>
  125 + </div>
  126 + </div>
  127 +
  128 + <div class="sidebar-subsection">
  129 + <div class="divider"></div>
  130 + <h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/reference.html">Reference</a></h3>
  131 + <div class="sidebar-subsection-contents always-show">
  132 + <ul>
  133 + <li id="high-level-package-summaries">
  134 +<div style="display: block;" class="package-summary">
  135 +<h4>
  136 +<a href="packages/addon-kit/addon-kit.html">addon-kit</a>
  137 +</h4>
  138 +
  139 +<ul class="modules">
  140 +<li class="module">
  141 +<a href="packages/addon-kit/docs/clipboard.html">clipboard</a>
  142 +</li>
  143 +
  144 +<li class="module">
  145 +<a href="packages/addon-kit/docs/context-menu.html">context-menu</a>
  146 +</li>
  147 +
  148 +<li class="module">
  149 +<a href="packages/addon-kit/docs/hotkeys.html">hotkeys</a>
  150 +</li>
  151 +
  152 +<li class="module">
  153 +<a href="packages/addon-kit/docs/notifications.html">notifications</a>
  154 +</li>
  155 +
  156 +<li class="module">
  157 +<a href="packages/addon-kit/docs/page-mod.html">page-mod</a>