Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(4)

Side by Side Diff: chrome/common/extensions/docs/external_extensions.html

Issue 9963120: Introduces an additional extension loader that load extra extensions based on per-extension json fi… (Closed) Base URL: https://src.chromium.org/svn/trunk/src/
Patch Set: Created 8 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 189 matching lines...) Expand 10 before | Expand all | Expand 10 after
200 <ol> 200 <ol>
201 <li> 201 <li>
202 <a href="#troubleshooting">Troubleshooting Mac OS permissions problems</a> 202 <a href="#troubleshooting">Troubleshooting Mac OS permissions problems</a>
203 </li> 203 </li>
204 </ol> 204 </ol>
205 </li><li> 205 </li><li>
206 <a href="#registry">Using the Windows registry</a> 206 <a href="#registry">Using the Windows registry</a>
207 <ol> 207 <ol>
208 </ol> 208 </ol>
209 </li><li> 209 </li><li>
210 <a href="#per-extension-install">Using per-extension preference fi les (Linux only)</a>
Finnur 2012/04/27 10:50:28 Um... I would tackle the documentation differently
Alexandre Abreu 2012/04/27 14:05:40 Done.
211 <ol>
212 </ol>
213 </li><li>
210 <a href="#updating">Updating and uninstalling</a> 214 <a href="#updating">Updating and uninstalling</a>
211 <ol> 215 <ol>
212 </ol> 216 </ol>
213 </li><li> 217 </li><li>
214 <a href="#faq">FAQ</a> 218 <a href="#faq">FAQ</a>
215 <ol> 219 <ol>
216 </ol> 220 </ol>
217 </li> 221 </li>
218 </ol> 222 </ol>
219 </div> 223 </div>
(...skipping 17 matching lines...) Expand all
237 when the user removes that other software. 241 when the user removes that other software.
238 </li> 242 </li>
239 <li> 243 <li>
240 A network admin wants to install the same extensions 244 A network admin wants to install the same extensions
241 throughout the company. 245 throughout the company.
242 </li> 246 </li>
243 </ul> 247 </ul>
244 <p> 248 <p>
245 An extension that's installed automatically is known as an 249 An extension that's installed automatically is known as an
246 <em>external extension</em>. 250 <em>external extension</em>.
247 Google Chrome supports two ways of 251 Google Chrome supports three ways of
Finnur 2012/04/27 10:50:28 Two. And revert the next two changes (line 257, 26
Alexandre Abreu 2012/04/27 14:05:40 Done.
248 installing external extensions: 252 installing external extensions:
249 </p> 253 </p>
250 <ul> 254 <ul>
251 <li> Using a preferences JSON file </li> 255 <li> Using a preferences JSON file </li>
252 <li> Using the Windows registry (Windows only) </li> 256 <li> Using the Windows registry (Windows only) </li>
257 <li> Using per-extension preference files (Linux only) </li>
253 </ul> 258 </ul>
254 <p> 259 <p>
255 Both ways support installing an extension from a <code>.crx</code> extension 260 Each method supports installing an extension from a <code>.crx</code> extension
256 file on the user's computer. The preferences JSON file also supports installing 261 file on the user's computer. The preferences JSON file also supports installing
257 an extension hosted at an 262 an extension hosted at an
258 <a href="autoupdate.html#H2-1">update URL</a>. 263 <a href="autoupdate.html#H2-1">update URL</a>.
259 See <a href="hosting.html">hosting</a> for details on hosting an extension. 264 See <a href="hosting.html">hosting</a> for details on hosting an extension.
260 </p> 265 </p>
261 <h2 id="prereqs">Before you begin</h2> 266 <h2 id="prereqs">Before you begin</h2>
262 <p> 267 <p>
263 First, package a 268 First, package a
264 <a href="packaging.html"><code>.crx</code> file</a> 269 <a href="packaging.html"><code>.crx</code> file</a>
265 and make sure that it installs successfully. 270 and make sure that it installs successfully.
(...skipping 144 matching lines...) Expand 10 before | Expand all | Expand 10 after
410 For example: 415 For example:
411 <ul> 416 <ul>
412 <li>path: <code>\\server\share\extension.crx</code> </li> 417 <li>path: <code>\\server\share\extension.crx</code> </li>
413 <li>version: <code>1.0</code> </li> 418 <li>version: <code>1.0</code> </li>
414 </ul> 419 </ul>
415 </li> 420 </li>
416 <li>Launch the browser and go to 421 <li>Launch the browser and go to
417 <b>chrome://extensions</b>; you should 422 <b>chrome://extensions</b>; you should
418 see the extension listed. </li> 423 see the extension listed. </li>
419 </ol> 424 </ol>
425 <h2 id="per-extension-install">Using per-extension preference files (Linux only) </h2>
426 <ol>
427 <li>Make the <code>.crx</code> extension file available
428 to the machine you want to install the extension on.
429 </li>
430 <li>Find or create the folder:
431 <ul>
432 <li> For a Google Chrome build: <code>/usr/share/google-chrome/extensions</cod e> </li>
433 <li> For a Chromium build: <code>/usr/share/chromium/extensions</code> </li>
434 </ul>
435 </li>
436 <li>Create a file under this folder with the following name:
437 <code>aaaaaaaaaabbbbbbbbbbcccccccccc.json</code> where the file name (without t he extension)
438 corresponds to your extension's ID.
439 </li>
440 <li>In the file created during step 4) above, specify the extension's
441 associated <code>.crx</code> complete path along with the
442 version your extension:
443 <p>
444 Example:
445 </p><pre> {
446 "external_crx": "/home/share/extension.crx",
447 "external_version": "1.0"
448 }
449 </pre>
450 <p></p>
451 </li>
452 <li>
453 Launch the browser and go to <b>chrome://extensions</b>; you
454 should see the extension listed with the proper version number.
455 </li>
Finnur 2012/04/27 10:50:28 Part of this segment should be deleted and parts (
Alexandre Abreu 2012/04/27 14:05:40 Done.
456 </ol>
420 <h2 id="updating">Updating and uninstalling</h2> 457 <h2 id="updating">Updating and uninstalling</h2>
421 <p>Google Chrome scans the metadata entries 458 <p>Google Chrome scans the metadata entries
422 in the preferences and registry 459 in the preferences and registry
423 each time the browser starts, and makes 460 each time the browser starts, and makes
424 any necessary changes to the installed 461 any necessary changes to the installed
425 external extensions. </p> 462 external extensions. </p>
426 <p>To update your extension to a new version, 463 <p>To update your extension to a new version,
427 update the file, and then update the version 464 update the file, and then update the version
428 in the preferences or registry. </p> 465 in the preferences or registry. </p>
429 <p>To uninstall your extension 466 <p>To uninstall your extension
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after
470 <p><b>What are some common mistakes when installing with the registry?</b> </p> 507 <p><b>What are some common mistakes when installing with the registry?</b> </p>
471 <ul> 508 <ul>
472 <li>Not specifying the same id/version 509 <li>Not specifying the same id/version
473 as the one listed in the <code>.crx</code> </li> 510 as the one listed in the <code>.crx</code> </li>
474 <li>Key created in the wrong location in the registry </li> 511 <li>Key created in the wrong location in the registry </li>
475 <li>Registry entry points to the wrong path to the <code>.crx</code> file 512 <li>Registry entry points to the wrong path to the <code>.crx</code> file
476 (or path specified but no filename) </li> 513 (or path specified but no filename) </li>
477 <li>Permissions problems on a network share </li> 514 <li>Permissions problems on a network share </li>
478 </ul> 515 </ul>
479 <br> 516 <br>
517 <p><b>What are some common mistakes when installing with the per-extension file? </b> </p>
518 <ul>
519 <li>Not specifying the same id/version
520 as the one listed in the <code>.crx</code> </li>
521 <li>Extension preference file created in the wrong location or with the wrong extension ID name </li>
522 <li>Extension entry points to the wrong path to the <code>.crx</code> file
523 (or path specified but no filename) </li>
524 <li>Permissions problems on a network share </li>
525 <li>
526 Syntax error in JSON file
527 (forgetting to separate entries with comma or
528 leaving a trailing comma somewhere) </li>
529 </ul>
530 <br>
480 <p><b>What if the user uninstalls the extension?</b> </p> 531 <p><b>What if the user uninstalls the extension?</b> </p>
481 <p>If the user uninstalls the extension through the UI, it will no 532 <p>If the user uninstalls the extension through the UI, it will no
482 longer be installed or updated on each startup. In other words, the 533 longer be installed or updated on each startup. In other words, the
483 external extension is blacklisted. </p> 534 external extension is blacklisted. </p>
484 <br> 535 <br>
485 <p><b>How do I get off the blacklist?</b> </p> 536 <p><b>How do I get off the blacklist?</b> </p>
486 <p>If the user uninstalls your extension, you should respect that 537 <p>If the user uninstalls your extension, you should respect that
487 decision. However, if you (the developer) accidentally uninstalled 538 decision. However, if you (the developer) accidentally uninstalled
488 your extension through the UI, 539 your extension through the UI,
489 you can remove the blacklist tag 540 you can remove the blacklist tag
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
522 _uff=0; 573 _uff=0;
523 urchinTracker(); 574 urchinTracker();
524 } 575 }
525 catch(e) {/* urchinTracker not available. */} 576 catch(e) {/* urchinTracker not available. */}
526 </script> 577 </script>
527 <!-- end analytics --> 578 <!-- end analytics -->
528 </div> 579 </div>
529 </div> <!-- /gc-footer --> 580 </div> <!-- /gc-footer -->
530 </div> <!-- /gc-container --> 581 </div> <!-- /gc-container -->
531 </body></html> 582 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698