641284 - page-mod documentation should have an example using contentScriptFile

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect, P1)

Description

[Dietrich Ayala (:dietrich)]

Because the construction of local file URLs is non-obvious and non-intuitive.

Comment 1

[Myk Melez [:myk] [@mykmelez]]

(automatic reprioritization of 1.0 bugs)

Comment 2

[Will Bamberg [:wbamberg]]

Attachment: Added example using contentScriptFile

Comment 3

[Dietrich Ayala (:dietrich)]

Comment on attachment 551917 [details] [diff] [review]
Added example using contentScriptFile

Review of attachment 551917 [details] [diff] [review]:
-----------------------------------------------------------------

r=me w/ these minor changes.

::: packages/addon-kit/docs/page-mod.md
@@ +63,5 @@
> +### Using `contentScriptFile` ###
> +
> +For conciseness the examples above, and the other examples in this page,
> +create content scripts as strings and use the `contentScript` property to
> +assign them.

This sentence is awkward. Maybe break it into two somehow?

@@ +77,5 @@
> +code like:
> +
> +    const data = require("self").data;
> +    
> +    var pageMod = require("page-mod");

This example uses const for 'data' but var for 'pageMod'. I think we should be consistent about how we bring external APIs into the current scope. But that doesn't need to be fixed just here, so it's up to you if you want to change this or not.

Comment 4

[Will Bamberg [:wbamberg]]

Thanks Dietrich! Landed as:
https://github.com/mozilla/addon-sdk/commit/0d9f3b8778b29a8d6de572230cdaf58803c7d1d2

> > +    const data = require("self").data;
> > +    
> > +    var pageMod = require("page-mod");
> 
> This example uses const for 'data' but var for 'pageMod'. I think we should
> be consistent about how we bring external APIs into the current scope. But
> that doesn't need to be fixed just here, so it's up to you if you want to
> change this or not.

It's a good catch: we decided we should var in all the examples, so I fixed the other ones in this file too.