Gecko Plugin API Reference

With the help of multiple contributors, the initial migration of the reference is complete. For the reference, the original document is at http://devedge-temp.mozilla.org/libr...02/plugin/1.0/ --Nickolay 00:37, 18 December 2006 (PST)

Markup notes

Please use the npapi template, Template:npapi-page, Template:npapi-section for cross-reference links. Example usage:

  • {{npapi("NPP_GetValue")}} becomes {{ npapi("NPP_GetValue") }}.
  • {{template("npapi-page", ["Preface"])}} becomes {{ npapi-page("Preface") }}.
  • {{template("npapi-section", ["Preface", "About this guide"])}} becomes {{ npapi-section("Preface", "About this guide") }}.

Put the PreviousNext/Next/Previous templates at the top and the bottom of every page (except for methods/structures reference). Example:

Categorizing pages

There are also undocumented Template:np-plugin-api and Template:np-browser-api templates created by User:Pmash. Apparently they are for methods listed in "Plug-in Side Plug-in API" and "Browser Side Plug-in API" sections of Gecko Plugin API Reference page. I'm not fond of the idea, but they probably could be used for now.

Pay attention to whitespace - the page's header should look like this:

<breadcrumbs></breadcrumbs> <title-override>NP_GetValue</title-override>
{{np-plugin-api}}
== Summary ==

Other pages should use the Template:npapiref, similarly to our other references. Right now the template simply adds the page in the NPAPI category. See Gecko_Plugin_API_Reference:Preface for example:

<breadcrumbs></breadcrumbs>
{{PreviousNext|Gecko Plugin API Reference:Previous page name|Gecko Plugin API Reference:Next page name}} {{npapiref}}
== Section name ==
...
page text
...

{{PreviousNext|Gecko Plugin API Reference:Previous page name|Gecko Plugin API Reference:Next page name}}
<!-- interwiki links etc. -->

Style

MDC tries to use 'Sentence caps' as opposed to Every Single Word Starts With A Capital style used in the reference. These ought to be fixed, although it's low priority. Note that if you change a section title, you should update the pages that link to that specific section to use the updated title.

"Netscape Gecko" should be replaced with simply "Gecko".



What's next?

It seems to me that almost all the contents have been migrated now, then what's next? What can I do to complete the migration? -- Kaz 07:29, 18 December 2006

The reference needs proof-reading to ensure all of it was migrated and all links are correct. One obvious problem with it currently is that there are multiple red links (like here) that use the older naming scheme. All links should be updated to use the npapi template I created. Example edit: --Nickolay 00:33, 18 December 2006 (PST)
See also the #Markup notes section on this page I created. --Nickolay 01:03, 18 December 2006 (PST)