Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 430341 of Documentation Wishlist

  • Revision slug: Project:Documentation_Wishlist
  • Revision title: Documentation Wishlist
  • Revision id: 430341
  • Created:
  • Creator: ethertank
  • Is current revision? No
  • Comment

Revision Content

{{MDCProjectPagesTOC}}

Make a wish

Is there a specific article or piece of documentation we're missing that you really wish we had? Add it to the list below. Unless you're sure there is no documentation on the topic you're interested in, please ask in the relevant newsgroup and/or on the MDC mailing list first. Also, please make your request easy to understand; add a link to a longer description of the request if needed.

Fulfill a wish

Do you want to contribute new content to the MDC, but aren't sure where to start? Pick a topic from the list below, research it, and write it up! When you're finished, please delete the item from the list.

If you would like to contribute but don't want to write a whole new document, check out our to do list.

For more information on how to help or how to get started see how to help.

Wishlist

Read the {{Anch("Make a wish")}} section above before editing.

Add examples to pages tagged NeedsExample. If a page on that list actually has a good example, please remove the tag. If you find a page that lacks an example, but don't know how to write that one, add the NeedsExample tag to the page.

  • MDC
    • Downloadable version for Offline use
  • How about a Cheat Sheet?
    • In respect to what, if I may ask?
  • JavaScript
    • New in JavaScript 1.8.6 (like this page: New in JavaScript 1.8.5)
    • >Introduction to Object-Oriented JavaScript (done)
    • Modifying Object Prototypes in JavaScript
    • Performance let vs. var should be added in one of Performance best practices in extensions or let and linked to each other. A statement on whether there's a difference between using var or let keywords should be added (no matter whether the performance is the same or different).
  • Introduction to AJAX (we have AJAX:Getting Started, but could use something more elaborate maybe)
  • SVG
    • Introduction to SVG: Part 1 What is SVG and how do I create SVG content
    • Introduction to SVG: Part 2 How can I (dynamically) handle/modify SVG content
    • SVG tutorial
  • HTML - XHTML
    • {{htmlelement("noembed")}}
    • HTML Reference
  • CSS
    • Using CSS Counters (started, but needs expanding)
    • CSS Reference (this is under development already, but could use a lot more content)
    • {{cssxref("box-decoration-break")}}
    • {{cssxref("break-inside")}}
    • {{cssxref("::choices")}}
    • {{cssxref("cross-fade")}}
    • {{cssxref("cycle")}}
    • {{cssxref("font-kerning")}}
    • {{cssxref("font-language-override")}}
    • {{cssxref("font-variant-ligatures")}}
    • {{cssxref("icon")}}
    • {{cssxref("image-resolution")}}
    • {{cssxref(":in-range")}}
    • {{cssxref("@namespace")}}
    • {{cssxref("nav-down")}}
    • {{cssxref("nav-index")}}
    • {{cssxref("nav-left")}}
    • {{cssxref("nav-right")}}
    • {{cssxref("nav-up")}}
    • {{cssxref("object-fit")}}
    • {{cssxref("object-position")}}
    • {{cssxref(":out-of-range")}}
    • {{cssxref(":read-only")}}
    • {{cssxref("::repeat-index")}}
    • {{cssxref("::repeat-item")}}
    • {{cssxref(":scope")}}
    • {{cssxref("text-combine-horizontal")}}
    • {{cssxref("text-orientation")}}
    • {{cssxref("touch-action")}}
    • {{cssxref("::value")}}
    • {{cssxref("var")}}
    • {{cssxref("var-*")}}
    • {{cssxref("@viewport")}}
  • DOM
    • {{domxref("DOMParser.parseFromString")}}
    • {{domxref("window.devicePixelRatio")}} (+{{domxref("window")}})
  • Mozilla development
    • Short page talking about the subset of doxygen markup that we use in IDL files (done)
    • Docs for tree-wide preprocessor macros (NS_ENSURE_SUCCESS, NS_ASSERTION, NS_SUCCEEDED, NS_ADDREF, NS_RELEASE, etc.) -- probably their definitions if not too abstruse and a brief description of use
    • Docs for tree-wide types (PRBool, PRUint32, nsresult, whatever other non-class non-standard types are used)
    • 'Bird's-eye view' articles on the architecture of the browser, of mail&news, etc.
    • An up-to-date article outlining the process contributing code, linked from Developing Mozilla. (making sure the bug you're fixing is not invalid or wontfix, maybe checking that overall direction of the fix is correct (e.g. when implementing UI), making changes, testing, Creating a patch, picking r/sr/ui-r people, getting the patch checked in). See also Hacking Firefox --Nickolay 01:15, 27 January 2007 (PST)
    • step by step mozilla development on scratcbox
    • Document explaining what is common with respect to features and source code between the different projects like Firefox, Thunderbird, SeaMonkey, Camino, etc. Basically explaining how much reuse is there between these projects in terms of features and source code.
  • Miscellaneous. Unclear requests will be eventually deleted. This is not the place for Firefox feature requests.
    • Tips & Tricks for creating usable interfaces
    • Change "netwerk" to "network" in your folder structure, example.
    • Drag and Drop of objects within tabs (what does this mean?)
    • some doc/example for selectedIndex in Javascript DOM (which selectedIndex?)
    • a brief description of "mozilla-filesystem". Most rpm packages of Firefox depend on the "mozilla-filesystem" package. What is it? Googling that phrase alone turns up dozens of mentions of the above dependency with no further details. A search of "developer.mozilla.org" yeilds no hits on the phrase "mozilla-filesystem".
    • Add any missing execCommand commands there may be. "enableInlineTableEditing" for example.

Revision Source

<div>
  {{MDCProjectPagesTOC}}</div>
<h2 id="Make_a_wish" name="Make_a_wish">Make a wish</h2>
<p>Is there a specific <strong>article or piece of documentation</strong> we're missing that you really wish we had? Add it to the <a href="/en-US/docs/Project:Documentation_Wishlist#Wishlist">list</a> below. Unless you're sure there is no documentation on the topic you're interested in, please ask in the relevant newsgroup and/or on the <a href="/en-US/docs/Project:Community">MDC mailing list</a> first. Also, please make your request easy to understand; add a link to a longer description of the request if needed.</p>
<h2 id="Fulfill_a_wish" name="Fulfill_a_wish">Fulfill a wish</h2>
<p>Do you want to contribute new content to the MDC, but aren't sure where to start? Pick a topic from the <a href="/en-US/docs/Project:Documentation_Wishlist#Wishlist">list</a> below, research it, and write it up! When you're finished, please delete the item from the list.</p>
<p>If you would like to contribute but don't want to write a whole new document, check out our <a href="/en-US/docs/Project:To-do_list">to do list</a>.</p>
<p>For more information on how to help or how to get started see <a href="/en-US/docs/Project:How_to_Help">how to help</a>.</p>
<h2 id="Wishlist" name="Wishlist">Wishlist</h2>
<p><strong>Read the {{Anch("Make a wish")}} section above before editing.</strong></p>
<p>Add examples to <a href="/docs/tag/NeedsExample">pages tagged NeedsExample</a>. If a page on that list actually has a good example, please remove the tag. If you find a page that lacks an example, but don't know how to write that one, add the NeedsExample tag to the page.</p>
<ul>
  <li>MDC
    <ul>
      <li>Downloadable version for Offline use</li>
    </ul>
  </li>
  <li>How about a Cheat&nbsp;Sheet?
    <ul>
      <li>In respect to what, if I&nbsp;may ask?</li>
    </ul>
  </li>
  <li>JavaScript
    <ul>
      <li>New in JavaScript 1.8.6 (like this page: <a href="/en-US/docs/JavaScript/New_in_JavaScript/1.8.5">New in JavaScript 1.8.5</a>)</li>
      <li><span class="done">&gt;Introduction to Object-Oriented JavaScript</span> (<a href="/en-US/docs/JavaScript/Introduction_to_Object-Oriented_JavaScript" title="Introduction_to_Object-Oriented_JavaScript">done</a>)</li>
      <li>Modifying Object Prototypes in JavaScript</li>
      <li>Performance let vs. var should be added in one of<a href="/en-US/docs/Extensions/Performance_best_practices_in_extensions" title="Extensions/Performance_best_practices_in_extensions"> Performance best practices in extensions</a> or <a href="/en-US/docs/JavaScript/Reference/Statements/let" title="JavaScript/Reference/Statements/let">let</a> and linked to each other. A statement on whether there's a difference between using var or let keywords should be added (no matter whether the performance is the same or different).</li>
    </ul>
  </li>
  <li>Introduction to AJAX (we have <a href="/en-US/docs/AJAX/Getting_Started" title="AJAX/Getting_Started">AJAX:Getting Started</a>, but could use something more elaborate maybe)</li>
  <li>SVG
    <ul>
      <li>Introduction to SVG: Part 1 What is SVG and how do I create SVG content</li>
      <li>Introduction to SVG: Part 2 How can I (dynamically) handle/modify SVG content</li>
      <li>SVG tutorial</li>
    </ul>
  </li>
  <li>HTML - XHTML
    <ul>
      <li>{{htmlelement("noembed")}}</li>
      <li>HTML Reference</li>
    </ul>
  </li>
</ul>
<ul>
  <li>CSS
    <ul>
      <li>Using <a href="/en-US/docs/CSS_Counters" title="CSS_Counters">CSS Counters</a> (started, but needs expanding)</li>
      <li><a href="/en-US/docs/CSS/CSS_Reference" title="CSS_Reference">CSS Reference</a> (this is under development already, but could use a lot more content)</li>
      <li>{{cssxref("box-decoration-break")}}</li>
      <li>{{cssxref("break-inside")}}</li>
      <li>{{cssxref("::choices")}}</li>
      <li>{{cssxref("cross-fade")}}</li>
      <li>{{cssxref("cycle")}}</li>
      <li>{{cssxref("font-kerning")}}</li>
      <li>{{cssxref("font-language-override")}}</li>
      <li>{{cssxref("font-variant-ligatures")}}</li>
      <li>{{cssxref("icon")}}</li>
      <li>{{cssxref("image-resolution")}}</li>
      <li>{{cssxref(":in-range")}}</li>
      <li>{{cssxref("@namespace")}}</li>
      <li>{{cssxref("nav-down")}}</li>
      <li>{{cssxref("nav-index")}}</li>
      <li>{{cssxref("nav-left")}}</li>
      <li>{{cssxref("nav-right")}}</li>
      <li>{{cssxref("nav-up")}}</li>
      <li>{{cssxref("object-fit")}}</li>
      <li>{{cssxref("object-position")}}</li>
      <li>{{cssxref(":out-of-range")}}</li>
      <li>{{cssxref(":read-only")}}</li>
      <li>{{cssxref("::repeat-index")}}</li>
      <li>{{cssxref("::repeat-item")}}</li>
      <li>{{cssxref(":scope")}}</li>
      <li>{{cssxref("text-combine-horizontal")}}</li>
      <li>{{cssxref("text-orientation")}}</li>
      <li>{{cssxref("touch-action")}}</li>
      <li>{{cssxref("::value")}}</li>
      <li>{{cssxref("var")}}</li>
      <li>{{cssxref("var-*")}}</li>
      <li>{{cssxref("@viewport")}}</li>
    </ul>
  </li>
</ul>
<ul>
  <li>DOM
    <ul>
      <li>{{domxref("DOMParser.parseFromString")}}</li>
      <li>{{domxref("window.devicePixelRatio")}} (+{{domxref("window")}})</li>
    </ul>
  </li>
</ul>
<ul>
  <li>Extensions
    <ul>
      <li>Developing Mozilla Thunderbird Extensions (started: <a href="/en-US/docs/Extensions/Thunderbird" title="Extensions/Thunderbird">Extensions:Thunderbird</a>)</li>
      <li>add <a href="https://www.mozdevgroup.com/docs/pete/Signing-an-XPI.html">Signing an XPI</a> to <a href="/en-US/docs/Extension_Packaging" title="Extension_Packaging">Extension Packaging</a></li>
      <li><span class="done">How to improve your extension's performance</span> (<a href="/en-US/docs/Extensions/Performance_best_practices_in_extensions" title="Performance best practices in extensions">done</a>)</li>
    </ul>
  </li>
  <li>Canvas
    <ul>
      <li>In privileged mode: How to create an image and copy it to the clipboard</li>
    </ul>
  </li>
</ul>
<ul>
  <li>Platform
    <ul>
      <li>Enable ClearType for easy reading.</li>
      <li>Writing an Options dialog using Firefox 1.5's new <a href="/en-US/docs/Mozilla/Preferences/Preferences_system" title="Preferences_System">Preferences System</a></li>
      <li>Multithreading in JavaScript</li>
      <li><span class="done">Reading binary data in JavaScript</span> see <a href="/en-US/docs/Code_snippets/File_I//O#Binary_File" title="Code_snippets/File_I//O#Binary_File">File I/O</a></li>
      <li><span class="done">Writing binary data in JavaScript</span> see <a href="/en-US/docs/Code_snippets/File_I//O#Writing_a_Binary_File" title="Code_snippets/File_I//O#Writing_a_Binary_File">File I/O</a></li>
      <li><span class="done">wrappedJSObject trick in XPCOM components </span> See <a href="/en-US/docs/wrappedJSObject" title="wrappedJSObject">wrappedJSObject</a>.</li>
      <li><span class="done">Generating hashes in JavaScript using nsICryptoHash</span> See <a href="/en-US/docs/XPCOM_Interface_Reference/nsICryptoHash" title="nsICryptoHash">nsICryptoHash</a></li>
      <li><span class="done"><a href="/en-US/docs/Storage" title="Storage">SQLite Storage API documentation</a></span> <a href="https://groups.google.com/group/mozilla.dev.apps.firefox/browse_frm/thread/87b91610451e4c94/eb0875c7fbc30113?lnk=st&amp;q=mozstorage+documentation&amp;rnum=1#eb0875c7fbc30113">started</a></li>
      <li>Realistic examples of working with protocols. Mozillazine's <a href="https://kb.mozillazine.org/Dev_:_Extending_the_Chrome_Protocol">«Extending the Chrome Protocol»</a> suggests redirecting to «data:» URLs, and Rosenberg's <a href="https://www.nexgenmedia.net/docs/protocol/">«Adding a New Protocol to Mozilla»</a> suggests redirecting to «javascript:» URLs, but a real example would involve returning a new custom channel, altering <a href="/en-US/docs/AsyncOpen" title="AsyncOpen">asyncOpen</a>, using <a href="/en-US/docs/XPCOM_Interface_Reference/nsIScriptableUnicodeConverter" title="nsIScriptableUnicodeConverter">nsIScriptableUnicodeConverter</a> for UTF-8 output, as Brian Fernandes <a href="https://groups.google.com/group/mozilla.dev.extensions/browse_thread/thread/cd03eb3bc26d2e15/67c57fe5d50d16e2">inquired.</a></li>
      <li>Gecko event reference, listing every event that Gecko generates.</li>
    </ul>
  </li>
</ul>
<ul>
  <li>Mozilla development
    <ul>
      <li><a href="/en-US/docs/Developer_Guide/Interface_development_guide/Commenting_IDL_for_better_documentation" title="Developer Guide/Interface development guide/Commenting IDL for better documentation">Short page talking about the subset of doxygen markup that we use in IDL files</a> (done)</li>
      <li>Docs for tree-wide preprocessor macros (<code>NS_ENSURE_SUCCESS</code>, <code>NS_ASSERTION</code>, <code>NS_SUCCEEDED</code>, <code>NS_ADDREF</code>, <code>NS_RELEASE</code>, etc.) -- probably their definitions if not too abstruse and a brief description of use
        <ul>
          <li>Some of these docs have been started, see <a href="/en-US/docs/tag/XPCOM_Macros" title="tag/XPCOM_Macros">Category:XPCOM Macros</a></li>
        </ul>
      </li>
      <li>Docs for tree-wide types (<code>PRBool</code>, <code>PRUint32</code>, <code>nsresult</code>, whatever other non-class non-standard types are used)</li>
      <li>'Bird's-eye view' articles on the architecture of the browser, of mail&amp;news, etc.</li>
      <li>An up-to-date article outlining the process contributing code, linked from <a href="/en-US/docs/Developer_Guide" title="Developing_Mozilla">Developing Mozilla</a>. (making sure the bug you're fixing is not invalid or wontfix, maybe checking that overall direction of the fix is correct (e.g. when implementing UI), making changes, testing, <a href="/en-US/docs/Creating_a_patch" title="Creating_a_patch">Creating a patch</a>, picking r/sr/ui-r people, getting the patch checked in). See also <a href="/en-US/docs/Hacking_Firefox" title="Hacking_Firefox">Hacking Firefox</a> --<a href="/User:Nickolay" title="User:Nickolay">Nickolay</a> 01:15, 27 January 2007 (PST)</li>
      <li>step by step mozilla development on scratcbox</li>
      <li>Document explaining what is common with respect to features and source code between the different projects like Firefox, Thunderbird, SeaMonkey, Camino, etc. Basically explaining how much reuse is there between these projects in terms of features and source code.</li>
    </ul>
  </li>
</ul>
<ul>
  <li>Miscellaneous. Unclear requests will be eventually deleted. <strong>This is not the place for Firefox feature requests</strong>.
    <ul>
      <li>Tips &amp; Tricks for creating usable interfaces</li>
      <li>Change "netwerk" to "network" in your folder structure, <a href="https://mxr.mozilla.org/mozilla-central/source/netwerk/base/public/nsIChannel.idl" title="https://mxr.mozilla.org/mozilla-central/source/netwerk/base/public/nsIChannel.idl">example</a>.</li>
      <li>Drag and Drop of objects within tabs (what does this mean?)</li>
      <li>some doc/example for <a href="/en-US/docs/SelectedIndex" title="SelectedIndex">selectedIndex</a> in Javascript DOM (which selectedIndex?)</li>
      <li>a brief description of "mozilla-filesystem". Most rpm packages of Firefox depend on the "mozilla-filesystem" package. What is it? Googling that phrase alone turns up dozens of mentions of the above dependency with no further details. A search of "developer.mozilla.org" yeilds no hits on the phrase "mozilla-filesystem".</li>
      <li>Add any missing execCommand commands there may be. "enableInlineTableEditing" for example.
        <ul>
          <li>concerning designMode in general, something needs to be done about <a href="/en-US/docs/Midas" title="Midas">Midas</a> and <a href="/en-US/docs/Rich-Text_Editing_in_Mozilla" title="Rich-Text_Editing_in_Mozilla">Rich-Text Editing in Mozilla</a></li>
        </ul>
      </li>
    </ul>
  </li>
</ul>
Revert to this revision