Revision 102989 of User:trevorh

  • Revision slug: User:trevorh
  • Revision title: User:trevorh
  • Revision id: 102989
  • Created:
  • Creator: trevorh
  • Is current revision? No
  • Comment 181 words added

Revision Content

I have created an add-on to help generate interface documentation, it is available at:
https://addons.mozilla.org/en-US/firefox/addon/207622/

To update existing documentation I follow these steps:

  1. Start running mdni for the interface, this process takes some time so you can continue with the next steps.
  2. Copy the source of the existing documentation to a text editor.
  3. Find and replace 'template.' with nothing, '.28.29' with '()', sometimes there will be excessive or unnecessary  , either remove them or replace with a regular space.
  4. When mdni has finished, copy the generated content.
  5. Paste the generated content into the source of a page on MDC, click the source button twice (this will format the source to make comparison easier).
  6. Copy the source of the generated documentation to a text editor and save.
  7. Use your favourite diff viewer (I use Meld) to move the relevant information to the generated content.
  8. Replace the original documentation with the generated documentation.
  9. If necessary make changes to the tags of the page.
  10. If necessary move the page to ../XPCOM Interface Reference/ .

Draft pages that I am working on:

//page.subpages;
//map.Keys(page.subpages);
//map.Values(page.subpages);
//map.KeyValues(page.subpages);
<ul>;
var pSubPagesMap = page.subpages;
var pSubPagesList = map.Values(pSubPagesMap);
var pSubPagesListOrdered = list.orderby(pSubPagesList, "title ascending");
foreach (var p in pSubPagesListOrdered) {
  <li>
    web.link(p.uri, p.title)&nbsp;
    date.Format(date.ChangeTimezone(p.date, user.timezone), "F");
    if (map.contains(p.tags, "delete")) { " - complete (tagged for deletion)"; }
  </>;
}
</ul>;

Revision Source

<p>I have created an add-on to help generate interface documentation, it is available at:<br>
<a class=" link-https" href="https://addons.mozilla.org/en-US/firefox/addon/207622/" title="https://addons.mozilla.org/en-US/firefox/addon/207622/">https://addons.mozilla.org/en-US/firefox/addon/207622/</a></p>
<p>To update existing documentation I follow these steps:</p>
<ol> <li>Start running mdni for the interface, this process takes some time so you can continue with the next steps.</li> <li>Copy the source of the existing documentation to a text editor.</li> <li>Find and replace 'template.' with nothing, '.28.29' with '()', sometimes there will be excessive or unnecessary &amp;nbsp;, either remove them or replace with a regular space.</li> <li>When mdni has finished, copy the generated content.</li> <li>Paste the generated content into the source of a page on MDC, click the source button twice (this will format the source to make comparison easier).</li> <li>Copy the source of the generated documentation to a text editor and save.</li> <li>Use your favourite diff viewer (I use Meld) to move the relevant information to the generated content.</li> <li>Replace the original documentation with the generated documentation.</li> <li>If necessary make changes to the tags of the page.</li> <li>If necessary move the page to ../XPCOM Interface Reference/ .</li>
</ol>
<p>Draft pages that I am working on:</p>
<pre class="script">//page.subpages;
//map.Keys(page.subpages);
//map.Values(page.subpages);
//map.KeyValues(page.subpages);
&lt;ul&gt;;
var pSubPagesMap = page.subpages;
var pSubPagesList = map.Values(pSubPagesMap);
var pSubPagesListOrdered = list.orderby(pSubPagesList, "title ascending");
foreach (var p in pSubPagesListOrdered) {
  &lt;li&gt;
    web.link(p.uri, p.title)&amp;nbsp;
    date.Format(date.ChangeTimezone(p.date, user.timezone), "F");
    if (map.contains(p.tags, "delete")) { " - complete (tagged for deletion)"; }
  &lt;/&gt;;
}
&lt;/ul&gt;;
</pre>
Revert to this revision